Skip to main content
POST
Send a test email

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer stfy_live_…. See Authentication for how to get one and which scopes it needs.

Path Parameters

campaign_id
string
required

The campaign's id, from GET /v1/campaigns

Body

application/json
to
string
required

Where it's sent: a member of your workspace

Required string length: 3 - 320
Pattern: ^[^@\s,]+@[^@\s,]+$
account_id
string | null

The account to fill account tags from

Maximum string length: 255
contact_email
string | null

A contact to fill in the merge tags as; left out, the recipient

Required string length: 3 - 320
Pattern: ^[^@\s,]+@[^@\s,]+$

Response

200 - application/json

Successful Response

id
string
required
to
string
required
sent
boolean
default:true