Sign in
sequences

Send a test email for a sequence step

post/v1/sequences/{sequenceId}/test-email

Path parameters

sequenceIdstring required

Public sequence ID.

Request body

tostring[] required

One or more recipient email addresses for the test email.

fromEmailAccountIdstring required

Public sending email account ID. The sender must be connected to the sequence.

subjectstring required

Subject line of the test email.

contentstring required

HTML body of the test email.

preheaderstring

Preview text shown in the recipient inbox.

Example request

{
  "to": [
    "qa.recipient@example.org"
  ],
  "fromEmailAccountId": "Y8aL4J6jaN",
  "subject": "OpenAPI test email",
  "content": "<p>Hello from OpenAPI validation.</p>",
  "preheader": "OpenAPI preheader"
}

Response

Test email sent successfully

{"stackTrail":"paths:/v1/sequences/{sequenceId}/test-email:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown","example":{"message":"Test email sent successfully"}}

Example response

{
  "message": "Test email sent successfully"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.