Get Custom Welcome Email

Version 4.0.24.18

Get the current status and content of custom welcome emails

Request

GET /custom_welcome_email
Datatype
Description
Request
HTTP Request

Response

200: Custom Welcome Email

Datatype
Description
enabled
boolean
If true, custom email content will replace the default body of welcome emails
content
string
The HTML to use as custom content for welcome emails. Script elements and other potentially dangerous markup will be removed.
subject
string
The text to appear in the email subject line. Only available with a whitelabel license and whitelabel_configuration.advanced_custom_welcome_email enabled.
header
string
The text to appear in the header line of the email body. Only available with a whitelabel license and whitelabel_configuration.advanced_custom_welcome_email enabled.

400: Bad Request

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

404: Not Found

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

429: Too Many Requests

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link