Initiate user email verification

POST/auth/user/emailVerification/start

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

Initiate the account verification process by sending out a verification email. For users who have lost the original message.

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

Authentication

This endpoint does not require authentication.

Request body

Content type: application/x-www-form-urlencoded

PropertyTypeRequiredConstraintsDescription
emailstringYesEmail address of user.
projectIdintegerYesID of project to which the user belongs.

Request example

email=janedoe%40tinkermode.com&projectId=1268

Responses

200 An email has been sent to the specified email address.

Content type: application/json

PropertyTypeRequiredConstraintsDescription
emailstringNo

Response example

{
  "email": "janedoe@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.