Send a test welcome email to the currently logged in user with the supplied content

Version 4.0.25.2 (latest)

Requests to this endpoint will send a welcome email with the custom content provided in the body to the currently logged in user.

Request

PUT /custom_welcome_email_test
Datatype
Description
Request
HTTP Request
body
HTTP Body
Expand HTTP Body definition...
body
Subject, header, and Body of the email to be sent.
Expand WelcomeEmailTest definition...
content
string
The content that would be sent in the body of a custom welcome email
subject
string
The subject that would be sent for the custom welcome email
header
string
The header that would be sent in the body of a custom welcome email

Response

200: Send Test Welcome Email

Datatype
Description
(object)
content
string
The content that would be sent in the body of a custom welcome email
subject
string
The subject that would be sent for the custom welcome email
header
string
The header that would be sent in the body of a custom welcome email

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

422: Validation Error

Datatype
Description
(object)
message
string
Error details
Expand ValidationErrorDetail definition...
field
string
Field with error
code
string
Error code
message
string
Error info message
documentation_url
string
Documentation link
documentation_url
string
Documentation link

429: Too Many Requests

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