API reference

Create, read, update, and delete contacts for the authenticated tenant.

• getList contacts
• postCreate a contact
• getLook up a contact
• getGet a contact by id
• patchUpdate a contact
• deleteDelete a contact

List, read, and update conversations.

• getList conversations
• getGet a conversation by id
• patchUpdate a conversation

List and read messages, and send new messages (queued for delivery).

• getList messages
• postSend a message (queued)
• getGet a message by id
• getDownload message media
• getList messages in a conversation

Read approved WhatsApp message templates.

• getList templates
• getGet template(s) by id or name

Create, manage, execute, and analyze broadcast campaigns.

• getList broadcasts
• postCreate a broadcast
• getGet a broadcast by id
• patchUpdate a broadcast
• deleteDelete a broadcast
• postExecute a broadcast now

Upsert commerce catalog products into Inaiy (source of truth before WhatsApp publish).

• postUpsert a catalog product
• postBatch upsert catalog products
• deleteArchive a product by externalId

Upload media for outbound messages and download pending uploads.

• postUpload media
• getGet pending media metadata
• getDownload / preview pending media

Read agents and teams so you can assign conversations.

• getList agents
• getGet an agent
• getList teams
• getGet a team

Messaging, template, broadcast, inbox, commerce, drip, AI agent and API usage reports.

• getMessaging analytics
• getTemplate analytics
• getBroadcast analytics summary
• getInbox analytics
• getPlan usage
• getCommerce analytics

OAuth 2.0 authorization server endpoints (authorize, token, revoke, introspect, userinfo).

• getAuthorization endpoint
• postToken endpoint
• postRevocation endpoint (RFC 7009)
• postIntrospection endpoint (RFC 7662)
• getUserInfo endpoint