Skip to main content
POST
Send a test

Authorizations

Authorization
string
header
required

An API token. The "read" ability: GET routes only. "read + write": every route.

Headers

Idempotency-Key
string

Replay a write safely: the same key gives back the first answer for 24 hours (header Idempotent-Replay: true). Read on POST, PUT and PATCH; DELETE ignores it. 255 characters at most.

Maximum string length: 255

Path Parameters

campaign
string<uuid>
required

The campaign's identifier (uuid).

Body

application/json
recipients
string<email>[]
required
Maximum array length: 5

Response

Test sent, or simulated with a test key.

message
string
required
recipients
string<email>[]
required

The addresses it went to, suppressed ones left out.

sandbox
boolean
required

true when a test key simulated it.