Skip to main content
POST
Test-send a trigger

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 trigger to test-send

Body

application/json
customer
string | null

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

to_email_address
string | null

The email address to test-send the trigger to

to_phone_number
string | null

The phone number to test-send the trigger to

variables
object | null

The variables to test-send the trigger with

email_address
string

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

phone_number
string

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

Response

200 - application/json

Whether the test send was successful

The response is of type object.