Skip to main content
POST
Send a step as a test email

Authorizations

Authorization
string
header
required

An API key from the console, starting ob_live_, sent as Authorization: Bearer <key>.

Headers

Idempotency-Key
string

Names this operation, so a retry with the same key and body gets the first success again, marked Idempotent-Replayed, instead of running or charging twice. A mailbox's password is not compared: the same mailbox sent again with another password is the same call, and gets the first answer. Kept 24 hours for your organization and this route. A refusal (4xx) frees the key at once, so a corrected retry runs. After a server error (5xx), which may still take effect, the key stays held for 5 minutes from the call's start, and a retry in that time answers 409 idempotency_in_progress; after that, a send or import that may already have gone out answers 409 idempotency_outcome_unknown instead of running again. 1 to 255 visible ASCII characters, such as a UUID.

Required string length: 1 - 255
Pattern: ^[\x21-\x7E]+$

Path Parameters

campaignId
string
required

The campaign's id.

Required string length: 24
Pattern: ^[0-9a-fA-F]+$
stepId
string
required

The step's id, from GET /v1/campaigns/{campaignId}/steps.

Required string length: 24
Pattern: ^[0-9a-fA-F]+$

Body

application/json
toEmail
string
required

Where the test goes: any address.

Example:

"maya@fernway.co"

fromEmail
string

The mailbox to send from: one of your active, connected mailboxes. Left out, the first active one the step can send from.

personId
string

The person the step is written for: someone on one of the campaign's lists. Left out, the first person of its first list.

Required string length: 24
Pattern: ^[0-9a-fA-F]+$

Response

The test email, sent.

toEmail
string
required
fromEmail
string
required

The mailbox it was sent from.

subject
string
required