Chatwoot tools
The 15 Chatwoot operations your product runs on your customer's account through Connect. All of them use the same endpoint, POST /api/tools/{tool}/execute.
- List conversationsGETLists conversations of an account, the open ones by default, with status, labels, inbox_id, can_reply, the contact in meta.sender, the assignee and the last message. data.meta has the counts by assignee type. Pages are numbered from 1; an empty payload means there are no more pages.
- Create conversationPOSTStarts a conversation with a contact in an inbox, optionally with a first message. source_id identifies the contact in that inbox: it comes from contact_inboxes of Search contacts, from Create contact or from Create contact inbox. On WhatsApp inboxes, the first message goes as an approved template in message.template_params.
- Update conversation statusPOSTSets the status of a conversation: open, resolved, pending or snoozed. Without snoozed_until a snoozed conversation waits for the next reply of the contact, and any reply of the contact reopens it.
- Assign conversationPOSTAssigns a conversation to an agent or to a team. When assignee_id is sent, team_id is ignored.
- Update conversation labelsPOSTSets the labels of a conversation. The list sent replaces the current labels, so it must include the ones to keep.
- List messagesGETReturns the latest messages of a conversation in ascending order, with meta holding its labels, contact and assignee. sender_type says who sent each message, and private marks internal notes. For older messages, pass before with the id of the oldest one received.
- Create messagePOSTSends a message in a conversation. An outgoing message goes to the contact through the channel of the inbox, such as WhatsApp, email or the website widget; private true makes it an internal note only agents see. On WhatsApp, template_params sends an approved template.
- Search contactsGETSearches the contacts that have an identifier, email or phone, by name, identifier, email or phone number, 15 per page. Each contact has contact_inboxes, pairing each inbox with the source_id that Create conversation needs. meta.count is the total; a page with fewer than 15 contacts is the last one.
- Create contactPOSTCreates a contact in an inbox of the account. The response brings the contact and the contact_inbox with the source_id that Create conversation needs.
- Update contactPUTUpdates a contact: send only the fields to change.
- Create contact inboxPOSTLinks an existing contact to another inbox and returns the contact_inbox with its source_id, for Create conversation when the contact has no source_id in that inbox yet.
- List inboxesGETLists the inboxes of the account, one per channel such as WhatsApp, website, email or API, with id, name and channel_type. The id is the inbox_id of conversations and contacts.
- List agentsGETLists the agents of the account with id, name, email, role and availability_status. The id is the assignee_id of a conversation.
- List teamsGETLists the teams of the account with id, name and whether the user of the connection is a member. The id is the team_id of conversations.
- Get profileGETReturns the connected user: id, name, email and the accounts the user belongs to, each with its id, name and role. The id of each account is the account_id that the other tools ask for. The access_token field of the response comes back masked.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
