Skip to main content
POST
Test-send a campaign

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

id
string
required

The ID of the campaign to test-send

Body

application/json
customer
string | null

The ID of the customer to test-send the campaign to

to_email_address
string | null

The email address to test-send the campaign to

to_phone_number
string | null

The phone number to test-send the campaign to

variables
object | null

The variables to test-send the campaign with

email_address
string

The ID of the email address to use as the sending address (overrides the campaign's configured email address)

phone_number
string

The ID of the phone number to use as the sending phone number (overrides the campaign's configured phone number)

step_ids
string[] | null

The IDs of the steps to test-send (if omitted, all steps are sent)

Response

200 - application/json

Whether the test-send was successful

The response is of type object.