Inbox
The shared inbox: conversations, messages and replies, in the same place where the team answers from the dashboard. It is how you connect a helpdesk or an external bot. An API key limited to some numbers only sees those numbers' conversations.
GETLive inbox eventsA Server-Sent Events stream of what happens in the inbox: new message, message status, conversation updated, someone typing. Events say what changed,…GETList conversationsConversations, newest first, paged by cursor: send the answer's nextCursor as cursor for the next page. folder picks the dashboard folder — mine is always…GETFolder countsFolder countsGETGet a conversationThe conversation with the full contact and the last campaigns it received.PATCHUpdate a conversationChanges the status (close, reopen, set pending, snooze until snoozedUntil), assigns it to a team member or pauses automations for 30 days. Each change…GETA conversation's messagesNewest first, with internal notes and events (assignment, closing) mixed in with the messages. For older pages, send the nextCursor as before.POSTReply in a conversationSends a message through the conversation's number, chosen by kind:POSTMark a conversation as readResets the unread counter and, if the account sends read receipts, marks the customer's last message as read on WhatsApp.POSTShow the typing indicatorShows the typing indicator to the customer, with the window open and read receipts on. At most once every 20 seconds per conversation.POSTUpload a file for a conversationSend the file bytes as the body (not multipart), with the name in X-File-Name. The type is detected from the content: image (JPEG, PNG), sticker (WebP),…GETLink to an inbox fileA temporary link to download a message file, received or sent. It lasts 5 minutes; ask for another when it expires.POSTLinks to many inbox filesThe same links as GET /inbox/media/{id}/url, for up to 100 files in a single request — use it when opening a conversation with lots of media, instead of…GETTeam membersWho can take conversations — this is where assignedUserId comes from. With phoneNumberId, only who handles that number.