Confirm your new sign-in email

POST

/api/v1/me/email-change/confirm

curl --request POST \
  --url https://api.deploybase.eu/api/v1/api/v1/me/email-change/confirm \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "code": "7KQ2ZP" }'

Checks the code mailed to the new address and makes it the sign-in address. You are then signed out everywhere and sign in with the new address. A change allows 5 tries and lasts 1 hour. Limited to 10 confirmations per person per hour. Requires a signed-in person: API keys are refused.

Authorizations

• BearerAuth

Request Body

The code from the mail

Media type application/json

object

code

string

Example

7KQ2ZP

Responses

200

OK

Media type application/json

object

data

meta

object

request_id

string

timestamp

string

trace_id

string

data

object

email

string

forms_still_notifying_old_address

FormsStillNotifyingOldAddress are forms in the person’s teams whose recipients still name the old address. They are not changed: a team admin decides whether the new address should receive them. Always present, possibly empty.

Array<object>

object

form_id

string

form_name

string

project_id

string

team_name

string

signed_out

boolean

Example

{
  "data": {
    "email": "sam@new-mailbox.eu",
    "forms_still_notifying_old_address": [
      {
        "form_id": "0b9e8f43-2d5c-4a51-9a3e-7c1d2e4f5a6b",
        "form_name": "Contact",
        "project_id": "5f0c1d2e-3a4b-4c5d-8e6f-7a8b9c0d1e2f",
        "team_name": "Acme"
      }
    ],
    "signed_out": true
  }
}

400

Malformed body, or EMAIL_CHANGE_CODE_INVALID with attempts_left

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

details

object

attempts_left

integer

Example

{
  "details": {
    "attempts_left": 3
  }
}

401

Unauthorized

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

403

HUMAN_SESSION_REQUIRED

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

404

NO_EMAIL_CHANGE

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

409

EMAIL_TAKEN

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

410

EMAIL_CHANGE_CODE_EXPIRED: start again

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

422

EMAIL_DOMAIN_MANAGED

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

429

Too many tries; see Retry-After

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

500

Internal Server Error

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}