Update 2FA Email message template
Change configuration options for your existing 2FA application Email message template.
Please log in to see full path URL. Learn why.
put
/2fa/2/applications/{appId}/email/messages/{msgId}
Authorizations:
Scopes:
Request rate limit:
40 requests / 10 minute (per account)
path Parameters
appId required | string Example: 0933F3BC087D2A617AC6DCB2EF5B8A61 ID of application for which requested message was created. |
msgId required | string Example: 16A8B5FE2BCD6CA716A2D780CB3F3390 Requested message ID. |
Request Body schema:
application/json
collapse all -
emailTemplateId | integer <int64> Email template ID that should reference a previously created Email template. |
from | string The sender of the 2FA message, an email address with an optional sender name (e.g. |
pinLength | integer <int32> PIN code length. |
pinType | string Enum: "NUMERIC" "ALPHA" "HEX" "ALPHANUMERIC" The type of PIN code that will be generated and sent as part of a 2FA message. |
Responses
default
successful response
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
429
Too Many Requests
4XX
Error responses
500
Internal Server Error
5XX
Error responses
Request samples
- Payload
- cURL
- Java
- C#
- Go
- Python
- PHP
- JavaScript
- NodeJs
- Ruby
Content type
application/json
Copy
Collapse all {- "pinType": "ALPHANUMERIC",
- "pinLength": 6,
- "from": "company@example.com",
- "emailTemplateId": 1234
}
Response samples
- default
- 400
- 401
- 403
- 404
- 429
- 4XX
- 500
- 5XX
Content type
application/json
Copy
Collapse all {- "messageId": "9C815F8AF3328",
- "applicationId": "HJ675435E3A6EA43432G5F37A635KJ8B",
- "pinLength": 4,
- "pinType": "ALPHANUMERIC",
- "from": "company@example.com",
- "emailTemplateId": 1234
}
Need assistance
Encountering issues
What's new? Check out
Unsure about a term? See