Version 4.0.24.14 (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
body
Expand HTTP Body definition...
body
Subject, header, and Body of the email to be sent.
Expand WelcomeEmailTest definition...
content
The content that would be sent in the body of a custom welcome email
subject
The subject that would be sent for the custom welcome email
header
The header that would be sent in the body of a custom welcome email
Response
200: Send Test Welcome Email
Datatype
Description
(object)
content
The content that would be sent in the body of a custom welcome email
subject
The subject that would be sent for the custom welcome email
header
The header that would be sent in the body of a custom welcome email
400: Bad Request
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
404: Not Found
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
422: Validation Error
Datatype
Description
(object)
message
lock
Error details
errors
Expand ValidationErrorDetail definition...
field
lock
Field with error
code
lock
Error code
message
lock
Error info message
documentation_url
lock
Documentation link
documentation_url
lock
Documentation link
429: Too Many Requests
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link