Sequences

Send Test Email

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

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

Send a test email for a sequence step

Authorization

x-api-key<token>

API key for Open API authentication

In: header

Request Body

application/jsonRequired

Send a test email for a specific sequence step. The sender (fromEmailAccountId) must already be connected to the sequence. Use the to array to send the test to multiple recipients in a single request.

toarray<string>

One or more recipient email addresses for the test email.

Example: ["[email protected]"]

fromEmailAccountIdstring

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

Example: "Y8aL4J6jaN"

subjectstring

Subject line of the test email.

Example: "OpenAPI test email"

contentstring

HTML body of the test email.

Example: "<p>Hello from OpenAPI validation.</p>"

preheaderstring

Preview text shown in the recipient inbox.

Example: "OpenAPI preheader"

Path Parameters

sequenceIdstring

Public sequence ID.

Request Body Examples

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

Responses

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

Request

Example:
curl -X POST \
  "https://open-api.saleshandy.com/v1/sequences/{sequenceId}/test-email" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "to": [
    "[email protected]"
  ],
  "fromEmailAccountId": "Y8aL4J6jaN",
  "subject": "OpenAPI test email",
  "preheader": "OpenAPI preheader",
  "content": "<p>Hello from OpenAPI validation.</p>"
}'

Response

No response body