Skip to main content
POST
Send a test step

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Headers

Idempotency-Key
string

Makes this write safe to retry: a repeat with the same key replays the first response instead of creating a second resource. Scoped to the account, remembered for 24 hours; reusing a key with a different payload is an error.

Maximum string length: 255

Path Parameters

sequence_id
string
required

The sequence's prefixed id (e.g. seq_abc123).

id
string
required

The step's prefixed id (e.g. seqst_abc123).

Body

application/json
to
string<email>

A team member's email address. Defaults to the authenticated user's.

customer_id
string

Render as this customer (cus_...). Omit to use every variable's default.

Response

The test email went out

A test email that went to a team member. It records no delivery, counts in no stats and unsubscribes nobody.

object
enum<string>
required
Available options:
email_test
to
string
required

The team member it was sent to.

subject
string
required

The subject sent, prefixed [Test].

provider_email_id
string | null

The email provider's id for the message.