Skip to main content
POST
/
campaigns
/
{id}
/
test_send
Test-send a campaign
curl --request POST \
  --url https://api.pocketflows.com/campaigns/{id}/test_send \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer": "<string>",
  "to_email_address": "<string>",
  "to_phone_number": "<string>",
  "variables": {},
  "email_address": "<string>",
  "phone_number": "<string>"
}
'
{}

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

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)

Response

200 - application/json

Whether the test-send was successful

The response is of type object.