Skip to main content
POST
SendTestDelivery

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
integrationId
string

Integration to send the test to.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
message
string | null

Message to carry in the test payload, so a test can be recognised on the receiving end. Defaults to a generic one.

Maximum string length: 500

Response

200 - application/json

Success

deliveryId
string

Id of the delivery created. Poll BatchGetDeliveries with it to follow the outcome.