Crisp tools
The 13 Crisp operations your product runs on your customer's account through Connect. All of them use the same endpoint, POST /api/tools/{tool}/execute.
- List websitesGETLists the Crisp workspaces, called websites in the API, where the plugin of this token is installed, with their website_id. Get website gives the name of each one. Pages start at 1, and an empty data list means there are no more pages.
- Get websiteGETReturns the name, domain and logo of a Crisp workspace, to tell apart the ids that List websites returns.
- List conversationsGETLists the conversations of a workspace, with session_id, state, unread counts, assigned operator, last message and the visitor meta (nickname, email, phone, segments). Pages start at 1, and a page with fewer items than per_page is the last one.
- Get conversationGETReturns a conversation with its state, assigned operator, unread counts, last message, people_id of the contact and the visitor meta. The messages come from List conversation messages.
- List conversation messagesGETReturns the latest batch of messages of a conversation, with type, sender, content and timestamp in milliseconds. To page towards older messages, send the timestamp of the oldest message of the batch as timestamp_before.
- Send messagePOSTSends a message as an operator in a conversation. type text goes to the visitor right away; type note is an internal note seen only by operators.
- Update conversation statePATCHChanges the state of a conversation to pending, unresolved or resolved.
- Assign conversationPATCHAssigns a conversation to an operator, who gets notified unless silent is true.
- Update conversation metaPATCHUpdates the visitor details and the subject or segments of a conversation. Send only the fields to change.
- List operatorsGETLists the operators and pending invites of a workspace. Each item has a type and a details object with user_id, email, name, role and availability; the user_id is what assignment, filters and mentions take.
- List peopleGETLists or searches the contacts (people profiles) of a workspace, with people_id, email, name, company, segments and notepad. Pages start at 1, and a page with fewer items than per_page is the last one.
- Create personPOSTCreates a contact (people profile) in a workspace and returns its people_id. email and person.nickname are required.
- Update personPATCHUpdates a contact (people profile). Crisp saves only the fields sent, on top of the previous version of the profile.
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.
