Skip to main content
POST
cURL
Technically, iCloud emails are supported… but their behavior is unpredictable.

Authorizations

Authorization
string
header
required

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

Body

application/json
to
string
required

Recipient's iMessage address. Must be in E.164 format.

Example:

"+1234567890"

action
enum<string>
required

Whether to start or stop sending typing indicators

Available options:
start,
stop
Example:

"start"

from
string | null

Your leased iMessage number. If none is provided, we will use a random iMessage number of yours.

Example:

"+15555555555"

Response

Start or stop sending typing indicators over iMessage

id
string
required
Example:

"req_xxxxxxxxxxxxxxxx"

timestamp
number
required
Example:

1772129047728

api_version
string
required
Example:

"v2026.2.26"

object
string
required
Example:

"response"

data
object
required