Skip to main content
POST
Send a Quick iMessage

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string

A UUID. When present, deduplicates repeat submissions. See /api-reference/idempotency.

Body

application/json
to
string
required

Recipient: E.164 phone (+14155550123) or the email address of their Apple ID

Maximum string length: 254
Pattern: ^(\+[1-9]\d{1,14}|[^\s@<>(),;:"]+@[^\s@<>(),;:"]+\.[a-zA-Z]{2,})$
text
string
required
Required string length: 1 - 2000

Response

Success

data
object
required