Skip to main content
POST
Queue a commitment-based SMS test or live send

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Body

application/json

Validated request fields for this operation.

commitment_id
integer
required

Organization-owned record identifier.

Example:

42

trigger
string
required

Trigger. Validation: required, string.

Example:

"Trigger"

year
integer | null

Year. Validation: nullable, integer.

Example:

2026

test
boolean | null
default:true

Test. Validation: nullable, boolean.

Example:

true

test_number
string | null

Test number. Validation: nullable, string.

Example:

"+15551234567"

Response

Operation result.

message
string
Example:

"SMS sent to +15551234567"