Change email address

POST/users/{userId}/changeEmail

Base URL: https://api.tinkermode.com

Changes the email address of the user. An verification email will be sent to the new email address. The user account's email address will be updated when the recipient clicks the verification link in the email.

This API call is only allowed for projects with email address-based user accounts.

Authentication

Send an Authorization header of the form ModeCloud <AUTH_CODE>.

Must contain API key of the matching user, or the API key of a user with permissions to create other users, a service account token with permissions on other users, or a Project API Key with admin permission.

Path parameters

NameTypeRequiredConstraintsDescription
userIdintegerYesThe unique ID for the specified user.

Request body

Content type: application/json

PropertyTypeRequiredConstraintsDescription
emailstringYesThe new email address to change to.

Request example

{
  "email": "new-email-user@tinkermode.com"
}

Responses

200 Successfully sent a verification email to the new email address.

Content type: application/json

Response example

{
  "newEmail": "new-email-user@tinkermode.com"
}

401 Authorization is required to access this resource.

Content type: application/json

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

403 Request failed because of invalid data or denied permission.

Content type: application/json

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

429 Request failed because of rate limit.

Content type: application/json

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

500 An unexpected error has occurred.

Content type: application/json

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

503 The service is temporarily unavailable.

Content type: application/json

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.