Skip to main content
POST
Send or schedule a text message

Authorizations

Authorization
string
header
required

OAuth 2.1 access tokens issued by Stytch Connected Apps.

x-api-key
string
header
required

API usage-plan key. Required on every request, sent as the x-api-key header.

Body

application/json
text
string
required
Required string length: 1 - 1599
members
string[]
Minimum array length: 1
Pattern: ^\d+$
distributionLists
string[]
Minimum array length: 1
Minimum string length: 1
all
boolean
phone
string
Minimum string length: 1
scheduleDelivery
boolean
deliveryDate
integer

Scheduled delivery time as epoch milliseconds.

frequency
integer
Required range: x >= 0
newsletter
boolean
mediaId
integer

Response

Per-recipient send results.

successes
object[]
required
failures
string[]
required