API Reference

Authenticated account, sender numbers, and contact cards.

• Get meGET /me
• List numbersGET /me/numbers
• Request call forwardingPOST /me/numbers/{number}/call-forwarding
• Get contact cardGET /me/numbers/{number}/contact-card
• Update contact cardPUT /me/numbers/{number}/contact-card
• Upload contact card avatarPOST /me/numbers/{number}/contact-card/avatar

Find My friend locations (device passthrough).

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

Sending surfaces (iMessage/Blooio, Twilio, WhatsApp, RCS, AMB) and their capabilities.

• List channelsGET /channels
• Get channelGET /channels/{channelId}
• Get channel capabilitiesGET /channels/{channelId}/capabilities
• Update channel profilePUT /channels/{channelId}/profile

Contacts, their channel identities, capabilities, timeline, and tags.

• 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 identitiesGET /contacts/{contactId}/identities
• Attach contact identityPOST /contacts/{contactId}/identities
• Detach contact identityDELETE /contacts/{contactId}/identities/{identityId}
• List contact tagsGET /contacts/{contactId}/tags
• Add contact tagsPOST /contacts/{contactId}/tags
• Remove contact tagDELETE /contacts/{contactId}/tags/{tag}
• Get contact timelineGET /contacts/{contactId}/timeline

Conversations and chat-level actions (typing, read, contact card, background).

• List chatsGET /chats
• Create chatPOST /chats
• Get chatGET /chats/{chatId}
• Update chatPATCH /chats/{chatId}
• Get chat backgroundGET /chats/{chatId}/background
• Set chat backgroundPUT /chats/{chatId}/background
• Remove chat backgroundDELETE /chats/{chatId}/background
• Share contact cardPOST /chats/{chatId}/contact-card
• List chat participantsGET /chats/{chatId}/participants
• Add chat participantPOST /chats/{chatId}/participants
• Remove chat participantDELETE /chats/{chatId}/participants/{identityId}
• Mark chat readPOST /chats/{chatId}/read
• Set typingPOST /chats/{chatId}/typing
• Stop typingDELETE /chats/{chatId}/typing

Send messages and read message history, status, events, and reactions.

• Create attachmentPOST /attachments
• Get attachmentGET /attachments/{attachmentId}
• List chat messagesGET /chats/{chatId}/messages
• Send message to chatPOST /chats/{chatId}/messages
• Get chat messageGET /chats/{chatId}/messages/{messageId}
• List message eventsGET /chats/{chatId}/messages/{messageId}/events
• Add reactionPOST /chats/{chatId}/messages/{messageId}/reactions
• Get message statusGET /chats/{chatId}/messages/{messageId}/status
• Send messagePOST /messages
• List templatesGET /templates
• Create templatePOST /templates
• Get templateGET /templates/{templateId}
• Delete templateDELETE /templates/{templateId}

Native iMessage polls (Blooio channels).

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

Group chats on group-capable channels (Blooio, WhatsApp).

• 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
• List group membersGET /groups/{groupId}/members

Webhook subscriptions and delivery attempts for inbound + lifecycle events.

• List webhooksGET /webhooks
• Create webhookPOST /webhooks
• Get webhookGET /webhooks/{webhookId}
• Update webhookPATCH /webhooks/{webhookId}
• Delete webhookDELETE /webhooks/{webhookId}
• List webhook deliveriesGET /webhooks/{webhookId}/deliveries
• Replay webhook deliveryPOST /webhooks/{webhookId}/deliveries/{deliveryId}/replay
• Rotate webhook secretPOST /webhooks/{webhookId}/secret/rotate

Unified activity feed across messages, polls, groups, reactions, and typing.

• List eventsGET /events
• Get eventGET /events/{eventId}

Phone number lookup and geocoding (enterprise plans).

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