staqlydocs
REST APIAPI referenceAccounts

Changing the email sign-in address, step 2 - send a code to the new address

Changing the email sign-in address, step 2 - send a code to the new address

Every request sends Authorization: Bearer ...: the access token in local mode, an API key stk_... in cloud mode. Use Send to try it against your cloud instance with your API key.

POST
/v1/account/sign-in-methods/email/change/new/start

409 change_not_verified until the current address is confirmed (step 1).

Authorization

headerAuthorizationBearer <token>

API key (stk_...), or in the Community Edition the access token (stk_local_...)

Header Parameters

Idempotency-Key?string

Replays the stored response when the same key is repeated with the same method, path, query string and body within 24 hours (422 idempotency_mismatch with a different request, 409 idempotency_in_progress while the first one runs). Not applied to multipart uploads or to responses that carry a secret.

Lengthlength <= 200

Request Body

application/json
  1. body
email*string
new_email*string

Response Body

Code sent

application/json
  1. response
resend_in*integer

Seconds until another code may be asked for

expires_in*integer

Seconds the code works

curl -X POST 'https://staqly.example.com/v1/account/sign-in-methods/email/change/new/start' \  -H 'Content-Type: application/json' \  -d '{  "email": "string",  "new_email": "string"}'
{  "resend_in": 0,  "expires_in": 0}