Sign in

v93

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01218121759.7 KB
Campaigns

Send campaign test

Queues a test send for a campaign and returns a durable email send ID for delivery-status inspection.

post/campaigns/{campaignId}/test

Path parameters

campaignIdstring required

Campaign ID

Request body

tostring email required

Test recipient email address.

Response

Test send accepted

successboolean
messagestring
campaignIdstring
recipientEmailstring email
emailSendIdstring

Durable delivery ID. Use this with GET /email-sends/{emailSendId}.

jobIdstring

Legacy queue identifier retained for response compatibility.

Example response

{
  "success": true,
  "message": "Test email queued for you@example.com"
}