POpocketflows
Campaigns

Test-send a campaign

post/campaigns/{id}/test_send

Request

Path parameters

idstring required

The ID of the campaign to test-send

Request body

customerstring nullable

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

to_email_addressstring nullable

The email address to test-send the campaign to

to_phone_numberstring nullable

The phone number to test-send the campaign to

variablesobject nullable

The variables to test-send the campaign with

email_addressstring

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

phone_numberstring

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

step_idsstring[] nullable

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

Response

Whether the test-send was successful

object required

Changes

No recorded changes to this operation across all 10 revisions of this API.