API Reference

Authentication and account information

• Get meGET /me

Manage phone numbers linked to your account

• List numbersGET /me/numbers
• Request call forwardingPOST /me/numbers/{number}/call-forwarding

Manage and share your iMessage contact card (Name & Photo)

• Share contact cardPOST /chats/{chatId}/contact-card
• Get my contact cardGET /me/numbers/{number}/contact-card
• Update my contact cardPUT /me/numbers/{number}/contact-card

Manage contacts (phone numbers and emails)

• List contactsGET /contacts
• Create contactPOST /contacts
• Get contactGET /contacts/{contactId}
• Update contactPATCH /contacts/{contactId}
• Delete contactDELETE /contacts/{contactId}
• Get contact capabilitiesGET /contacts/{contactId}/capabilities
• List contact tagsGET /contacts/{contactId}/tags
• Add contact tagsPOST /contacts/{contactId}/tags
• Remove contact tagDELETE /contacts/{contactId}/tags/{tag}

Manage contact groups

• List groupsGET /groups
• Create groupPOST /groups
• Get groupGET /groups/{groupId}
• Update groupPATCH /groups/{groupId}
• Delete groupDELETE /groups/{groupId}
• Set group iconPOST /groups/{groupId}/icon
• Remove group iconDELETE /groups/{groupId}/icon

Manage group membership

• List group membersGET /groups/{groupId}/members
• Add group memberPOST /groups/{groupId}/members
• Remove group memberDELETE /groups/{groupId}/members/{contactId}

Manage webhook subscriptions

• List webhooksGET /webhooks
• Create webhookPOST /webhooks
• Get webhookGET /webhooks/{webhookId}
• Update webhookPATCH /webhooks/{webhookId}
• Delete webhookDELETE /webhooks/{webhookId}
• Rotate webhook secretPOST /webhooks/{webhookId}/secret/rotate

View and replay webhook deliveries

• List webhook logsGET /webhooks/{webhookId}/logs
• Replay webhook eventPOST /webhooks/{webhookId}/logs/{eventId}/replay

View conversations and messages

• List chatsGET /chats
• Get chatGET /chats/{chatId}
• Get chat backgroundGET /chats/{chatId}/background
• Set chat backgroundPUT /chats/{chatId}/background
• Remove chat backgroundDELETE /chats/{chatId}/background

View individual messages and their status

• List chat messagesGET /chats/{chatId}/messages
• Send messagePOST /chats/{chatId}/messages
• Get messageGET /chats/{chatId}/messages/{messageId}
• Get message statusGET /chats/{chatId}/messages/{messageId}/status

Control typing indicators for conversations

• Start typingPOST /chats/{chatId}/typing
• Stop typingDELETE /chats/{chatId}/typing

Mark conversations as read

• Mark chat readPOST /chats/{chatId}/read

Add or remove reactions to messages. Supports classic iMessage tapbacks (love, like, dislike, laugh, emphasize, question) and emoji reactions (e.g. +😂, -😂).

• Add reactionPOST /chats/{chatId}/messages/{messageId}/reactions

Send native iMessage polls and retrieve poll results with vote counts. Poll events are delivered via separate webhook event types (poll.received, poll.created, poll.voted) and require webhook_type 'poll' or 'all'.

• Send pollPOST /chats/{chatId}/polls
• Get poll resultsGET /chats/{chatId}/polls/{pollId}

FindMy contact location tracking

• List location contactsGET /location/contacts
• Refresh location contactsPOST /location/contacts/refresh
• Get location contactGET /location/contacts/{handle}

Initiate FaceTime calls

• Call face timePOST /facetime/calls

Phone number validation, formatting, and NANPA geocoding. Requires an Enterprise plan (Dedicated Enterprise).

• Batch lookup phone numbersPOST /phone-numbers/batch
• Lookup phone numberGET /phone-numbers/lookup
• Lookup phone number postPOST /phone-numbers/lookup