Skip to main content
POST
cURL
Only customers who lease numbers that support iMessage can use this endpoint.
Phone numbers must be in E.164 format with country codes.
Contiguity supports iCloud emails… but their behavior is unpredictable at times.

Message formatting

Format message text with markdown-style syntax. Supported styles:
iMessage showing bold, italics, strikethrough, underline, and combined formatting styles.

Example of formatted text in an iMessage conversation.

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. E.164 phone number or email (e.g. name@icloud.com).

Example:

"+1234567890"

from
string | null

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

Example:

"+15555555555"

message
string

Message to send. Required unless attachments are provided.

Example:

"Hello, world!"

fallback
object | null

Should Contiguity fallback to SMS/RCS if the recipient does not have iMessage, or if iMessage fails to send? Ignored when to is an email — SMS/MMS fallback is not available for email addresses.

Example:
attachments
string[] | null

Attachments to send. Must be HTTPS-secured URLs with file extensions. Max 10 attachments, with a cumulative size of 50MB.

Maximum array length: 10
Example:
effect
enum<string> | null

Optional iMessage bubble or screen effect.

Available options:
slam,
loud,
gentle,
invisible_ink,
echo,
spotlight,
balloons,
confetti,
love,
lasers,
fireworks,
celebration,
shooting_star
Example:

"confetti"

fast_track
boolean

Fast track your request (bypassing any recommended rate limiting). Only available on leased numbers. Requires acceptance of the Fast Track Terms.

Response

Send an iMessage

id
string
required
Example:

"req_xxxxxxxxxxxxxxxx"

timestamp
number
required
Example:

1787117739720

api_version
string
required
Example:

"v2026.8.19"

object
string
required
Example:

"response"

data
object
required