Send 2FA PIN code over Email
Send a PIN code over Email using previously created Email message template.
Authorizations:
Scopes:
Request Body schema:
| applicationId required | string The ID of the application that represents your service, e.g. 2FA for login, 2FA for changing the password, etc. | ||
| from | string Use this parameter if you wish to override the sender from the created Email message template parameter | ||
| messageId required | string The ID of the Email message template (message with the PIN placeholder) that is sent to the recipient. | ||
| placeholders | object Key value pairs that will be replaced during message sending. Placeholder keys should NOT contain curly brackets and should NOT contain a | ||
| |||
| to required | string Email address to which the 2FA message will be sent. Example: john.smith@example.com. | ||
Responses
successful response
Bad Request
Unauthorized
Forbidden
Error responses
Internal Server Error
Error responses
Request samples
- Payload
- cURL
- Java
- C#
- Go
- Python
- PHP
- JavaScript
- NodeJs
- Ruby
{- "applicationId": "1234567",
- "messageId": "7654321",
- "to": "john.smith@example.com",
- "placeholders": {
- "firstName": "John"
}
}Response samples
- default
- 400
- 401
- 403
- 4XX
- 500
- 5XX
{- "pinId": "9C817C6F8AF3D48F9FE553282AFA2B67",
- "to": "john.smith@example.com",
- "emailStatus": {
- "name": "PENDING_ACCEPTED",
- "description": "Message accepted, pending for delivery."
}
}
Need assistance
Encountering issues
What's new? Check out
Unsure about a term? See
Service status'%3E %3Cpath d='M11.9047 8.47667L19.3513 0H17.5873L11.1187 7.35867L5.956 0H0L7.80867 11.1287L0 20.0167H1.764L8.59067 12.244L14.044 20.0167H20M2.40067 1.30267H5.11067L17.586 18.778H14.8753' fill='%23424B5C'/%3E %3C/g%3E %3Cdefs%3E %3CclipPath id='clip0_3438_1744'%3E %3Crect width='20' height='20.0167' fill='white'/%3E %3C/clipPath%3E %3C/defs%3E %3C/svg%3E)
