The Crisp REST API offers access and control over all Crisp data (conversations, contacts and more).
This documents the publicly-available routes available to plugin or website tiers. user tiers are not intended for public use, although routes also available to user tiers are marked as such.
All resources that you will most likely use are prefixed with a star symbol (⭐).
While integrating the REST API, you may be interested in the following guides:
You may also download the ⬇️ Postman collection that we provide for the Crisp REST API.
Basein Website
Check If Website Exists
Checks if given website exists (by domain).
The website domain to check against
- HEADhttps://api.crisp.chat/v1/website
- Tiersuserwebsiteplugin
(loading)
(loading)
Get A Website
Resolves an existing website information.
The website identifier
Website identifier
Website name
Website domain
Website custom logo image URL (can be blank)
Website verification status
Website institutional status
- GEThttps://api.crisp.chat/v1/website/website_id
- Tiersuserwebsiteplugin
(loading)
(loading)
Conversationsin Website
⭐ List Conversations
Lists conversations for website.
The website identifier
Page number for conversations paging
Page size for conversations paging (between 20 and 50, defaults to 20)
Search query in all conversations (text if type is text or segment, filter if type is filter)
Search type (either text, segment or filter)
Search operator if search type is filter (or or and respectful to boolean algebra, defaults to and if not set)
Whether to include conversations without any message (1 or 0, defaults to 0)
Whether to return only conversations categorized under provided inbox identifier (use all for all inboxes)
Whether to return only conversations with unread messages (1 or 0, defaults to 0)
Whether to return only conversations that are resolved (1 or 0, defaults to 0)
Whether to return only conversations that are not resolved (1 or 0, defaults to 0)
Whether to return only conversations where user is mentioned (1 or 0, defaults to 0)
Whether to return only conversations containing scheduled messages created by the user (1 or 0, defaults to 0)
Whether to return only conversations that are assigned to user identifier
Whether to return only conversations that are not assigned to any user (1 or 0, defaults to 0)
When to start relative to conversation update date (date, ISO 8601, eg. 2018-03-01T17:00:00.000Z)
When to end relative to conversation update date (date, ISO 8601, eg. 2018-04-01T10:30:00.000Z)
Whether to order conversations by date created instead of default order (1 or 0, defaults to 0)
Whether to order conversations by date updated instead of default order (1 or 0, defaults to 0)
Whether to order conversations by longest date waiting instead of default order, this also filters out non-waiting conversations (1 or 0, defaults to 0)
Session identifier
Website identifier
Inbox identifier
People identifier
Conversation state
Values
pendingunresolvedresolved
Conversation status (an alias of state; useful for sorting conversations)
Values
0Numeric code for pending status1Numeric code for unresolved status2Numeric code for resolved status
Whether session is verified or not (user email ownership is authenticated)
Whether session is blocked or not (block messages from visitor)
Visitor availability
Values
onlineoffline
User activity statistics (eg. moved their mouse if reported from the Crisp chatbox)
Whether user is considered active right now or not
Timestamp at which the user was last active
Last message excerpt (from visitor)
Preview of conversation (message from visitor or operator)
Preview message type
Values
textnotefileanimationaudiopickerfieldcarousel
Preview message sender
Values
useroperator
Preview message excerpt
Preview message fingerprint
Topic for conversation (based on messages)
Verified identities for this conversation
Verified identity
Values
email
Verification method
Values
linkManual verification by user via a linksdkAutomatic verification from a Crisp SDKapiAutomatic verification from a REST APIdkimAutomatic verification from email (DKIM signed)spfAutomatic verification from email (SPF origin)
Annotation of verified identity (if any)
External participants for this conversation
External participant type
Values
email
External participant target (ie. email address, identifier, etc.)
Mentioned user / team identifiers
Number of scheduled messages from all operators
Conversation creation timestamp
Conversation update timestamp
Conversation waiting since timestamp (if any)
Compose states
Compose state for operator
Compose state type
Values
startstop
Message excerpt for compose state
Timestamp for compose state
Compose user information
Compose user identifier
Compose user nickname
Compose user avatar
Whether compose is automated or not (ie. comes from a bot)
Compose state for visitor
Compose state type
Values
startstop
Message excerpt for compose state
Timestamp for compose state
Whether compose is automated or not (ie. comes from a bot)
Unread messages counters
Unread messages counter for operator
Unread messages counter for visitor
Assigned operator (if any)
Operator user identifier
Meta-data for conversation
Visitor nickname
Visitor email
Visitor phone
Visitor address
Subject for conversation (if any)
Conversation origin
Values
chatemailurn:*
Visitor IP address
Connection information (auto-generated based on IP address)
ISP name
AS number
Visitor data
Visitor avatar
Device information
Visitor device capabilities
Values
browsingcall
Geolocation information for visitor device
Country code
Region code
City name
Location coordinates
Latitude coordinate
Longitude coordinate
Visitor device system information
Operating system information
OS version
OS name
Rendering engine information
Engine version
Engine name
Browser information
Browser major version (eg: version 8.1 has a major of 8)
Browser version
Browser name
Visitor user agent
Visitor device timezone offset (UTC)
Visitor device locales
Segments attributed to conversation
- GEThttps://api.crisp.chat/v1/website/website_id/conversations/page_number
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:sessions
(loading)
(loading)
List Suggested Conversation Segments
Lists suggested conversation segments for website.
The website identifier
The page number (paging in segment list)
Segment value
Number of occurences of this segment
- GEThttps://api.crisp.chat/v1/website/website_id/conversations/suggest/segments/page_number
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:suggest
(loading)
(loading)
Delete Suggested Conversation Segment
Deletes a suggested conversation segment for website.
The website identifier
Segment to be deleted from suggestions
- DELETEhttps://api.crisp.chat/v1/website/website_id/conversations/suggest/segment
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:suggest
(loading)
(loading)
List Suggested Conversation Data Keys
Lists suggested conversation data keys for website.
The website identifier
The page number (paging in data list)
Data key value
Number of occurences of this data key
- GEThttps://api.crisp.chat/v1/website/website_id/conversations/suggest/data/page_number
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:suggest
(loading)
(loading)
Delete Suggested Conversation Data Key
Deletes a suggested conversation data key for website.
The website identifier
Data key to be deleted from suggestions
- DELETEhttps://api.crisp.chat/v1/website/website_id/conversations/suggest/data
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:suggest
(loading)
(loading)
Conversationin Website
⭐ Create A New Conversation
Creates a new conversation.
user from value.The website identifier
- POSThttps://api.crisp.chat/v1/website/website_id/conversation
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:initiate
(loading)
(loading)
Check If Conversation Exists
Checks if given conversation session identifier exists.
The website identifier
The conversation session identifier
- HEADhttps://api.crisp.chat/v1/website/website_id/conversation/session_id
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:sessions
(loading)
(loading)
⭐ Get A Conversation
Resolves conversation information.
The website identifier
The conversation session identifier
Session identifier
Website identifier
Inbox identifier
People identifier
Conversation state
Values
pendingunresolvedresolved
Conversation status (an alias of state; useful for sorting conversations)
Values
0Numeric code for pending status1Numeric code for unresolved status2Numeric code for resolved status
Whether session is verified or not (user email ownership is authenticated)
Whether session is blocked or not (block messages from visitor)
Visitor availability
Values
onlineoffline
User activity statistics (eg. moved their mouse if reported from the Crisp chatbox)
Whether user is considered active right now or not
Timestamp at which the user was last active
Last message excerpt
Preview of conversation (message from visitor or operator)
Preview message type
Values
textnotefileanimationaudiopickerfieldcarousel
Preview message sender
Values
useroperator
Preview message excerpt
Preview message fingerprint
Topic for conversation (based on messages)
Mentioned user / team identifiers
Verified identities for this conversation
Verified identity
Values
email
Verification method
Values
linkManual verification by user via a linksdkAutomatic verification from a Crisp SDKapiAutomatic verification from a REST APIdkimAutomatic verification from email (DKIM signed)spfAutomatic verification from email (SPF origin)
Annotation of verified identity (if any)
External participants for this conversation
External participant type
Values
email
External participant target (ie. email address, identifier, etc.)
Number of scheduled messages from all operators
Conversation creation timestamp
Conversation update timestamp
Conversation waiting since timestamp (if any)
Compose states
Compose state for operator
Compose state type
Values
startstop
Message excerpt for compose state
Timestamp for compose state
Compose user information
Compose user identifier
Compose user nickname
Compose user avatar
Whether compose is automated or not (ie. comes from a bot)
Compose state for visitor
Compose state type
Values
startstop
Message excerpt for compose state
Timestamp for compose state
Whether compose is automated or not (ie. comes from a bot)
Unread messages counters
Unread messages counter for operator
Unread messages counter for visitor
Assigned operator (if any)
Operator user identifier
Meta-data for conversation
Visitor nickname
Visitor email
Visitor phone
Visitor address
Subject for conversation (if any)
Conversation origin
Values
chatemailurn:*
Visitor IP address
Connection information (auto-generated based on IP address)
ISP name
AS number
Visitor data
Visitor avatar
Device information
Visitor device capabilities
Values
browsingcall
Geolocation information for visitor device
Country code
Region code
City name
Location coordinates
Latitude coordinate
Longitude coordinate
Visitor device system information
Operating system information
OS version
OS name
Rendering engine information
Engine version
Engine name
Browser information
Browser major version (eg: version 8.1 has a major of 8)
Browser version
Browser name
Visitor user agent
Visitor device timezone offset (UTC)
Visitor device locales
Segments attributed to conversation
- GEThttps://api.crisp.chat/v1/website/website_id/conversation/session_id
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:sessions
(loading)
(loading)
Remove A Conversation
Removes a conversation in website.
The website identifier
The conversation session identifier
- DELETEhttps://api.crisp.chat/v1/website/website_id/conversation/session_id
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:sessions
(loading)
(loading)
Initiate A Conversation With Existing Session
Initiates a conversation from an existing session.
Used to initiate a conversation from website visitor list.
The client acknowledgement is sent back asynchronously on the RTM Events channel, using the event namespace session:request:initiated.
The website identifier
The conversation session identifier
- POSThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/initiate
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:initiate
(loading)
(loading)
⭐ Get Messages In Conversation
Resolves messages in an existing conversation. Returns the last batch of messages if there are many messages in the conversation. Then, messages can be paged towards older messages using the timestamp_before parameter, towards more recent messages using the timestamp_after parameter, or centered around a given timestamp using the timestamp_around parameter.
The website identifier
The conversation session identifier
Returned message batch should end before given timestamp (used for infinite scroll paging towards older messages)
Returned message batch should start after given timestamp (used for infinite scroll paging towards more recent messages)
Returned message batch should be centered around given timestamp (used to jump to a specific message)
Session identifier
Website identifier
Message type
Values
textnotefileanimationaudiopickerfieldcarouselevent
Message sender
Values
useroperator
Message origin
Values
chatemailurn:*
Message content (string if type is text or note, object if type is file, animation, audio, picker, field, carousel or event)
Object identifier (only set if message type is picker or field)
Object text (only set if message type is picker, field, carousel or event)
Object explanatory text (only set if message type is field)
Object value (only set if message type is field)
Object choices (only set if message type is picker)
Choice value
Choice icon (if any, must be an emoji character)
Choice label
Whether choice is selected or not
Specific action to take when choice gets clicked (if any)
Action type
Values
framelink
Action target URL
Object targets (only set if message type is carousel)
Target title
Target description
Target banner image URL (if any)
Target action buttons
Action label
Action link URL
Object name (only set if message type is file)
Object duration in seconds (only set if message type is audio)
Object URL (only set if message type is file, animation or audio)
Object MIME type (only set if message type is file, animation or audio)
Event namespace (only set if message type is event)
Values
state:resolveduser:blockedreminder:scheduledthread:startedthread:endedparticipant:addedparticipant:removedcall:startedcall:ended
Indicates if message must be filled before continuing (only set if message type is picker or field)
Preview of URLs contained in message
Previewed URL
Website domain for previewed URL
Page title for previewed URL
Preview information
Text excerpt from the page (may not be set)
Main image from the page (may not be set)
Embeddable frame of main page media (may not be set)
Whether message was fully processed in the internal Crisp pipeline (eg: preview was done)
Whether message was edited after being sent or not
Whether message was auto-translated or not
Whether message is automated or not (ie. comes from a bot)
Mentioned user / team identifiers
Channel in which message has been read (can be empty)
Values
chatemailurn:*
Channel in which message has lastly been delivered (can be empty)
Values
chatemailurn:*
Channels for which message delivery has been ignored (if any)
Channel name (eg. email)
Ignore class type (eg. recipient)
Reason for which the delivery has been ignored (eg. unsubscribed)
Unique message fingerprint (useful to avoid duplicates when using the API as per with the real-time sockets)
Timestamp at which the message was sent
Sending user information
Sending user type (if any)
Values
websiteparticipant
Sending user identifier (may be operator user identifier or session identifier)
Sending user nickname
Sending user avatar
References adding more context to message (if any)
Reference type
Values
link
Reference name
Reference target (eg. page URL if type is link)
Original message data (if any)
Original identifier
Arbitrary properties set on the message (if any)
- GEThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/messages
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:messages
(loading)
(loading)
⭐ Send A Message In Conversation
Sends a message in an existing conversation.
The website identifier
The conversation session identifier
Message type
Values
textnotefileanimationaudiopickerfieldcarouselevent
Message sender
Values
useroperator
Message origin
Values
chatemailurn:*
Message content (string if type is text or note, object if type is file, animation, audio, picker, field, carousel or event)
Object identifier (only set if message type is picker or field)
Object text (only set if message type is picker, field, carousel or event)
Object explanatory text (only set if message type is field)
Object value (only set if message type is field)
Object choices (only set if message type is picker)
Choice value
Choice icon (must be an emoji character)
Choice label
Whether choice is selected or not
Specific action to take when choice gets clicked
Action type
Values
framelink
Action target URL
Object targets (only set if message type is carousel)
Target title
Target description
Target banner image URL
Target action buttons
Action label
Action link URL
Object name (only set if message type is file)
Object duration in seconds (only set if message type is audio)
Object URL (only set if message type is file, animation or audio)
Object MIME type (only set if message type is file, animation or audio)
Event namespace (only set if message type is event)
Values
state:resolveduser:blockedreminder:scheduledthread:startedthread:endedparticipant:addedparticipant:removedcall:startedcall:ended
Indicates if message must be filled before continuing (only set if message type is picker or field)
Mentioned user / team identifiers
Unique message fingerprint (useful to avoid duplicates when using the API as per with the real-time sockets)
Sending user information
Sending user type
Values
websiteparticipant
Sending user nickname
Sending user avatar
References adding more context to message
Reference type
Values
link
Reference name
Reference target (eg. page URL if type is link)
Original message data (if set, original data will then be available on a separate route)
Original message data MIME type
Values
text/plaintext/html
Original message data content
Arbitrary properties set on the message
Timestamp at which the message was sent, in milliseconds (if different than the current timestamp, eg. to ingest older messages)
Message stealth mode (ie. do not propagate message to the other party)
Whether message was auto-translated or not
Whether message is automated or not (ie. comes from a bot)
- POSThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/message
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:messages
(loading)
(loading)
Get A Message In Conversation
Resolves an existing message in an existing conversation.
The website identifier
The conversation session identifier
The message fingerprint
Session identifier
Website identifier
Message type
Values
textnotefileanimationaudiopickerfieldcarouselevent
Message sender
Values
useroperator
Message origin
Values
chatemailurn:*
Message content (string if type is text or note, object if type is file, animation, audio, picker, field, carousel or event)
Object identifier (only set if message type is picker or field)
Object text (only set if message type is picker, field, carousel or event)
Object explanatory text (only set if message type is field)
Object value (only set if message type is field)
Object choices (only set if message type is picker)
Choice value
Choice icon (if any, must be an emoji character)
Choice label
Whether choice is selected or not
Specific action to take when choice gets clicked (if any)
Action type
Values
framelink
Action target URL
Object targets (only set if message type is carousel)
Target title
Target description
Target banner image URL (if any)
Target action buttons
Action label
Action link URL
Object name (only set if message type is file)
Object duration in seconds (only set if message type is audio)
Object URL (only set if message type is file, animation or audio)
Object MIME type (only set if message type is file, animation or audio)
Event namespace (only set if message type is event)
Values
state:resolveduser:blockedreminder:scheduledthread:startedthread:endedparticipant:addedparticipant:removedcall:startedcall:ended
Indicates if message must be filled before continuing (only set if message type is picker or field)
Preview of URLs contained in message
Previewed URL
Website domain for previewed URL
Page title for previewed URL
Preview information
Text excerpt from the page (may not be set)
Main image from the page (may not be set)
Embeddable frame of main page media (may not be set)
Whether message was fully processed in the internal Crisp pipeline (eg: preview was done)
Whether message was edited after being sent or not
Whether message was auto-translated or not
Whether message is automated or not (ie. comes from a bot)
Mentioned user / team identifiers
Channel in which message has been read (can be empty)
Values
chatemailurn:*
Channel in which message has lastly been delivered (can be empty)
Values
chatemailurn:*
Channels for which message delivery has been ignored (if any)
Channel name (eg. email)
Ignore class type (eg. recipient)
Reason for which the delivery has been ignored (eg. unsubscribed)
Unique message fingerprint (useful to avoid duplicates when using the API as per with the real-time sockets)
Timestamp at which the message was sent
Sending user information
Sending user type (if any)
Values
websiteparticipant
Sending user identifier (may be operator user identifier or session identifier)
Sending user nickname
Sending user avatar
References adding more context to message (if any)
Reference type
Values
link
Reference name
Reference target (eg. page URL if type is link)
Original message data (if any)
Original identifier
Arbitrary properties set on the message (if any)
- GEThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/message/fingerprint
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:messages
(loading)
(loading)
Update A Message In Conversation
Edits an existing message in an existing conversation.
The updated event is sent back asynchronously on the RTM Events channel, using the event namespace message:updated.
The website identifier
The conversation session identifier
The edited message fingerprint
Message content (string if type is text or note, object if type is file, animation, audio, picker, field, carousel or event)
Object identifier (only set if message type is picker or field)
Object text (only set if message type is picker, field, carousel or event)
Object explanatory text (only set if message type is field)
Object value (only set if message type is field)
Object choices (only set if message type is picker)
Choice value
Choice icon (must be an emoji character)
Choice label
Whether choice is selected or not
Specific action to take when choice gets clicked
Action type
Values
framelink
Action target URL
Object targets (only set if message type is carousel)
Target title
Target description
Target banner image URL
Target action buttons
Action label
Action link URL
Object name (only set if message type is file)
Object duration in seconds (only set if message type is audio)
Object URL (only set if message type is file, animation or audio)
Object MIME type (only set if message type is file, animation or audio)
Event namespace (only set if message type is event)
Values
state:resolveduser:blockedreminder:scheduledthread:startedthread:endedparticipant:addedparticipant:removedcall:startedcall:ended
Indicates if message must be filled before continuing (only set if message type is picker or field)
- PATCHhttps://api.crisp.chat/v1/website/website_id/conversation/session_id/message/fingerprint
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:messages
(loading)
(loading)
Remove A Message In Conversation
Removes an existing message in an existing conversation. Used to retract a previously-sent message.
The updated event is sent back asynchronously on the RTM Events channel, using the event namespace message:removed.
The website identifier
The conversation session identifier
The removed message fingerprint
- DELETEhttps://api.crisp.chat/v1/website/website_id/conversation/session_id/message/fingerprint
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:messages
(loading)
(loading)
Compose A Message In Conversation
Starts or stop composing a message in an existing conversation. This route is used for MagicType preview.
The website identifier
The conversation session identifier
Compose type
Values
startstop
Compose sender
Values
useroperator
Compose excerpt (MagicType preview)
Compose stealth mode (ie. do not propagate compose to the other party)
Whether compose is automated or not (ie. comes from a bot)
- PATCHhttps://api.crisp.chat/v1/website/website_id/conversation/session_id/compose
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:messages
(loading)
(loading)
⭐ Mark Messages As Read In Conversation
Marks messages as read in conversation. Either using given message fingerprints, or all messages.
The website identifier
The conversation session identifier
Sender direction
Values
useroperator
Read receipt origin
Values
chatemailurn:*
Target message fingerprints (if not set, this marks all messages as read in conversation)
- PATCHhttps://api.crisp.chat/v1/website/website_id/conversation/session_id/read
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:messages
(loading)
(loading)
Mark Conversation As Unread
Marks whole conversation as unread.
The website identifier
The conversation session identifier
Sender direction
Values
user
- PATCHhttps://api.crisp.chat/v1/website/website_id/conversation/session_id/unread
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:messages
(loading)
(loading)
⭐ Mark Messages As Delivered In Conversation
Marks messages as delivered in conversation.
The website identifier
The conversation session identifier
Sender direction
Values
operator
Delivered receipt origin
Values
chatemailurn:*
Target message fingerprints
- PATCHhttps://api.crisp.chat/v1/website/website_id/conversation/session_id/delivered
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:messages
(loading)
(loading)
Update Conversation Open State
Updates conversation open state for authenticated operator user. Lets other operators see which conversation people are on at any given moment. This state automatically expires after a while, if not renewed.
The website identifier
The conversation session identifier
Open state
- PATCHhttps://api.crisp.chat/v1/website/website_id/conversation/session_id/open
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:actions
(loading)
(loading)
⭐ Get Conversation Routing Assign
Resolves assigned operator for conversation routing.
The website identifier
The conversation session identifier
Assigned operator (if any)
Operator user identifier
- GEThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/routing
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:routing
(loading)
(loading)
⭐ Assign Conversation Routing
Assigns conversation routing to an operator, or unassign.
The website identifier
The conversation session identifier
Assigned operator (set to blank value for none)
Operator user identifier
Whether to notify the assigned operator or not
- PATCHhttps://api.crisp.chat/v1/website/website_id/conversation/session_id/routing
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:routing
(loading)
(loading)
Update Conversation Inbox
Updates inbox used for conversation.
The website identifier
The conversation session identifier
Inbox identifier (or none)
- PATCHhttps://api.crisp.chat/v1/website/website_id/conversation/session_id/inbox
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:sessions
(loading)
(loading)
⭐ Get Conversation Metas
Resolves conversation meta information.
The website identifier
The conversation session identifier
Visitor nickname
Visitor email
Visitor phone
Visitor address
Subject for conversation (if any)
Conversation origin
Values
chatemailurn:*
Visitor IP address
Connection information (auto-generated based on IP address)
ISP name
AS number
Visitor data
Visitor avatar
Device information
Visitor device capabilities
Values
browsingcall
Geolocation information for visitor device
Country code
Region code
City name
Location coordinates
Latitude coordinate
Longitude coordinate
Visitor device system information
Operating system information
OS version
OS name
Rendering engine information
Engine version
Engine name
Browser information
Browser major version (eg: version 8.1 has a major of 8)
Browser version
Browser name
Visitor user agent
Visitor device timezone offset (UTC)
Visitor device locales
Segments attributed to conversation
- GEThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/meta
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:sessions
(loading)
(loading)
⭐ Update Conversation Metas
Updates conversation meta information.
The website identifier
The conversation session identifier
Visitor nickname
Visitor email
Visitor avatar
Visitor IP address
Visitor data
Visitor phone number
Visitor address
Subject for conversation (or none)
Conversation origin
Values
chatemailurn:*
Segments for conversation
Visitor device information
Visitor device capabilities
Values
browsingcall
Geolocation information for visitor device
Country code (can be blank)
Region code (can be blank)
City name (can be blank)
Location coordinates
Latitude coordinate
Longitude coordinate
Visitor device system information
Operating system information
OS version
OS name
Rendering engine information
Engine version
Engine name
Browser information
Browser major version (eg: version 8.1 has a major of 8)
Browser version
Browser name
Visitor user agent
Visitor device timezone offset (UTC)
Visitor device locales
- PATCHhttps://api.crisp.chat/v1/website/website_id/conversation/session_id/meta
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:sessions
(loading)
(loading)
Get An Original Message In Conversation
Resolves an existing original message in an existing conversation. This route is mainly used to retrieve original HTML content and headers for emails.
The website identifier
The conversation session identifier
The original identifier
Website identifier
Session identifier
Original identifier
Original message data MIME type
Values
text/plaintext/html
Original message headers
Original message data content
Timestamp at which the original was stored
- GEThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/original/original_id
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:messages
(loading)
(loading)
List Conversation Pages
Lists browsed pages in conversation.
The website identifier
The conversation session identifier
The page number (paging in page list)
Page title as seen by visitor browser
Page URL
Page referrer (if any)
Timestamp of page access (when the page was loaded)
- GEThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/pages/page_number
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:pages
(loading)
(loading)
List Conversation Events
Lists stacked events in conversation.
The website identifier
The conversation session identifier
The page number (paging in event list)
Text for event
Data for event (if any)
Color for event (if any)
Values
redorangeyellowgreenbluepurplepinkbrowngreyblack
Timestamp of event (when the event was stacked)
- GEThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/events/page_number
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:events
(loading)
(loading)
List Conversation Files
Lists files in conversation (extracted from messages).
The website identifier
The conversation session identifier
The page number (paging in file list)
File name
File MIME type
File URL
Unique file message fingerprint (file container message)
Timestamp of file message (when the file container message was sent)
- GEThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/files/page_number
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:messages
(loading)
(loading)
Get Conversation State
Resolves conversation state (resolved, unresolved or pending).
The website identifier
The conversation session identifier
Conversation state
Values
pendingunresolvedresolved
- GEThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/state
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:states
(loading)
(loading)
⭐ Change Conversation State
Updates conversation state (resolved, unresolved or pending).
The website identifier
The conversation session identifier
Conversation state
Values
pendingunresolvedresolved
Event message user information
User type
Values
website
User nickname
User avatar
Event message origin
Values
chatemailurn:*
- PATCHhttps://api.crisp.chat/v1/website/website_id/conversation/session_id/state
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:states
(loading)
(loading)
Get Conversation Relations
Resolves conversation relations (related conversations: parents and children, if any).
The website identifier
The conversation session identifier
Related conversations
Parent session identifier (if any)
Child session identifiers
- GEThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/relations
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:sessions
(loading)
(loading)
Get Conversation Participants
Resolves conversation participants (external participants, eg. emails to be set in CC).
The website identifier
The conversation session identifier
External participants for conversation
External participant type
Values
email
External participant target (ie. email address, identifier, etc.)
- GEThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/participants
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:participants
(loading)
(loading)
Save Conversation Participants
Saves conversation participants (external participants, eg. emails to be set in CC).
The website identifier
The conversation session identifier
External participants for conversation
External participant type
Values
email
External participant target (ie. email address, identifier, etc.)
Event message user information
User type
Values
website
User nickname
User avatar
Event message origin
Values
chatemailurn:*
- PUThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/participants
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:participants
(loading)
(loading)
Get Block Status For Conversation
Resolves conversation block status.
The website identifier
The conversation session identifier
Block state
- GEThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/block
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:actions
(loading)
(loading)
Block Incoming Messages For Conversation
Blocks further incoming messages from a conversation. Messages from visitor will be silently dropped, but you can still send messages to visitor.
The website identifier
The conversation session identifier
Block state
Event message user information
User type
Values
website
User nickname
User avatar
Event message origin
Values
chatemailurn:*
- PATCHhttps://api.crisp.chat/v1/website/website_id/conversation/session_id/block
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:actions
(loading)
(loading)
Get Verify Status For Conversation
Resolves conversation verify status.
The website identifier
The conversation session identifier
Verify status
Verified identities
Verified identity
Values
email
Verification method
Values
linkManual verification by user via a linksdkAutomatic verification from a Crisp SDKapiAutomatic verification from a REST APIdkimAutomatic verification from email (DKIM signed)spfAutomatic verification from email (SPF origin)
Annotation of verified identity (if any)
- GEThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/verify
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:actions
(loading)
(loading)
Update Verify Status For Conversation
Updates conversation verify status. When a conversation user is verified, a verified badge shows in the Crisp apps.
The website identifier
The conversation session identifier
Verify status
- PATCHhttps://api.crisp.chat/v1/website/website_id/conversation/session_id/verify
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:actions
(loading)
(loading)
Request Identity Verification For Conversation
Requests a verification of an identity channel for conversation. Verifying a channel automatically marks the whole conversation as verified, showing a verified badge in the Crisp apps.
Once the user verified ownership of their identity, an acknowledgement will be sent on the RTM Events channel, using the event namespace session:update_verify. The verified identity will appear in verifications.
If requesting an identity verification for a plugin (with identity set to a plugin URN, eg. urn:crisp.im:whatsapp:0), then the identity:verify:request event will be sent on the RTM Events channel. It is the responsibility of the target plugin to react to this identity verification request event, and deliver the provided verification code to the end-user. Other identity verification methods, such as email and phone, are fully managed by Crisp end-to-end and therefore they do not require a custom implementation.
The website identifier
The conversation session identifier
Which channel to verify
Values
emailphoneurn:*
Verification method
Values
link
Recipient for the verification (if any, defaults to eg. conversation email if none, required if plugin)
- POSThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/verify/identity
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:identities
(loading)
(loading)
Redeem Identity Verification Link For Conversation
Redeems a verification link to verify an identity channel for conversation.
The website identifier
The conversation session identifier
Which channel to verify
Values
emailphoneurn:*
Recipient for the verification
Verification token (6 digits TOTP, if any required)
- PUThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/verify/identity/link
(loading)
(loading)
Request Email Transcript For Conversation
Requests an email transcript for a conversation. The transcript is emailed to the authenticated user, or to the indicated email. It contains all conversation history and may be kept for as an external record.
The website identifier
The conversation session identifier
Target user to send the transcript to
Values
useroperator
Target email (if not set, the transcript is sent to the email address of the target user)
- POSThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/transcript
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:actions
(loading)
(loading)
Request Chatbox Binding Purge For Conversation
Requests a chatbox binding purge for conversation. The visitor must be online for the purge to be proceeded.
The website identifier
The conversation session identifier
- POSThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/purge
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:actions
(loading)
(loading)
Request User Feedback For Conversation
Requests feedback from user for conversation. The visitor must be online for the feedback request to be delivered.
The website identifier
The conversation session identifier
- POSThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/feedback
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:actions
(loading)
(loading)
List Browsing Sessions For Conversation
Lists available browsing sessions for conversation. A browsing session can be initiated to stream user screen content to operators.
The website identifier
The conversation session identifier
Browsing session identifier
Browsing token (used to authenticate cross-channel requests, eg. to the HTTP proxy)
Useragent for browsing session
- GEThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/browsing
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:browsing
(loading)
(loading)
Initiate Browsing Session For Conversation
Initiates browsing session for conversation.
Used to ask a client to prepare for a streamed browsing session for all open tabs, and request acknowledgement of when the client is ready to accept browsing stream actions (one acknowledgement per tab).
The client acknowledgement is sent back asynchronously on the RTM Events channel, using the event namespace browsing:request:initiated if initiated, or browsing:request:rejected if not initiated.
The website identifier
The conversation session identifier
- POSThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/browsing
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:browsing
(loading)
(loading)
Send Action To An Existing Browsing Session
Sends an action to an existing browsing session. Used to send stream actions to a browsing session (eg. to start or stop the stream session).
The client acknowledgement is sent back asynchronously on the streaming channel, using either the event namespace app:browsing:action:started or app:browsing:action:stopped (depending on the request action parameter, if action is start or stop).
The website identifier
The conversation session identifier
The browsing session identifier
Browsing action
Values
startstopheartbeat
- PATCHhttps://api.crisp.chat/v1/website/website_id/conversation/session_id/browsing/browsing_id
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:browsing
(loading)
(loading)
Assist An Existing Browsing Session
Assists an existing browsing session. Used by LiveAssist™ to start or stop an assist session, used by operators to take control on the screen of user browser (mouse move and scroll).
The client acknowledgement is sent back asynchronously on the streaming channel, using either the event namespace app:browsing:assist:started or app:browsing:assist:stopped (depending on the request action parameter, if action is start or stop). Other actions do not imply real-time feedbacks.
The website identifier
The conversation session identifier
The browsing session identifier
Assist action
Values
startstopheartbeatmousescrollclick
Mouse position for assist cursor in browsing session (action must be mouse)
Mouse cursor horizontal position
Mouse cursor vertical position
Click target for assist cursor in browsing session (action must be click)
Click cursor horizontal position
Click cursor vertical position
Scroll position for assist scroll wheel in browsing session (action must be scroll)
Scroll wheel horizontal position
Scroll wheel vertical position
- PATCHhttps://api.crisp.chat/v1/website/website_id/conversation/session_id/browsing/browsing_id/assist
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:browsing
(loading)
(loading)
Initiate New Call Session For Conversation
Initiates a new audio/video call session for conversation.
Used to request a client to open a call session (audio + video). The client acknowledgement is sent back asynchronously on the RTM Events channel, using either the event namespace call:request:accept or call:request:decline.
The website identifier
The conversation session identifier
Mode of the call to start
Values
videoaudio
Event message user information
User type
Values
website
User nickname
User avatar
Event message origin
Values
chatemailurn:*
- POSThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/call
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:calls
(loading)
(loading)
Get Ongoing Call Session For Conversation
Gets the ongoing audio/video call session for conversation.
The website identifier
The conversation session identifier
Call session identifier (if any call ongoing)
- GEThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/call
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:calls
(loading)
(loading)
Abort Ongoing Call Session For Conversation
Aborts the ongoing audio/video call session for conversation.
The website identifier
The conversation session identifier
The call identifier
Event message user information
User type
Values
website
User nickname
User avatar
Event message origin
Values
chatemailurn:*
- DELETEhttps://api.crisp.chat/v1/website/website_id/conversation/session_id/call/call_id
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:calls
(loading)
(loading)
Transmit Signaling On Ongoing Call Session
Transmits a signaling payload for the ongoing audio/video call session for conversation.
Used to emit a signaling payload to the other client, that is also part of the call session. The client signaling payloads are sent back asynchronously on the streaming channel, using either the event namespace app:call:signaling:sdp or app:call:signaling:candidate.
The website identifier
The conversation session identifier
The call identifier
Signaling type to transmit
Values
sdpcandidate
Signaling payload to transmit
- PATCHhttps://api.crisp.chat/v1/website/website_id/conversation/session_id/call/call_id/signaling
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:calls
(loading)
(loading)
Request Tool Call For Conversation
Requests a new WebMCP tool call on the chatbox widget for conversation.
Note that this route is only available to plugin tiers, because the full tool namespace is generated from the plugin URN and the tool name. This is done for proper tool isolation on the chatbox, for security reasons.
The website identifier
The conversation session identifier
Command to run (arbitrary, implementation-specific)
Payload attached to command (if any)
- POSThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/tool
- Tiersplugin
- Scopeswebsite:conversation:tools
(loading)
(loading)
Schedule A Reminder For Conversation
Schedules a reminder in the future for conversation, with a note to your future-self. A push notification and an email will be sent, as well as a note in the conversation.
The website identifier
The conversation session identifier
Date in the future at which you want to be reminded (ISO 8601)
Note message to be sent as a reminder
Event message user information
User type
Values
website
User nickname
User avatar
Event message origin
Values
chatemailurn:*
- POSThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/reminder
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:reminders
(loading)
(loading)
Report Conversation
Reports a conversation to Crisp and remove it from the inbox. This can be used to move an entire conversation to spams.
The website identifier
The conversation session identifier
Reporting flag
Values
spam
- POSThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/report
- Tiersuserwebsiteplugin
- Scopeswebsite:conversation:actions
(loading)
(loading)
Peoplein Website
Get People Statistics
Resolves the amount of people stored in the CRM.
The website identifier
Total number of people
- GEThttps://api.crisp.chat/v1/website/website_id/people/stats
- Tiersuserwebsiteplugin
- Scopeswebsite:people:statistics
(loading)
(loading)
List Suggested People Segments
Lists suggested segments for people.
The website identifier
The page number (paging in segment list)
Segment value
Number of occurences of this segment
- GEThttps://api.crisp.chat/v1/website/website_id/people/suggest/segments/page_number
- Tiersuserwebsiteplugin
- Scopeswebsite:people:suggest
(loading)
(loading)
Delete Suggested People Segment
Deletes a suggested segment for people.
The website identifier
Segment to be deleted from suggestions
- DELETEhttps://api.crisp.chat/v1/website/website_id/people/suggest/segment
- Tiersuserwebsiteplugin
- Scopeswebsite:people:suggest
(loading)
(loading)
List Suggested People Data Keys
Lists suggested data keys for people.
The website identifier
The page number (paging in data list)
Data key value
Number of occurences of this data key
- GEThttps://api.crisp.chat/v1/website/website_id/people/suggest/data/page_number
- Tiersuserwebsiteplugin
- Scopeswebsite:people:suggest
(loading)
(loading)
Delete Suggested People Data Key
Deletes a suggested data key for people.
The website identifier
Data key to be deleted from suggestions
- DELETEhttps://api.crisp.chat/v1/website/website_id/people/suggest/data
- Tiersuserwebsiteplugin
- Scopeswebsite:people:suggest
(loading)
(loading)
List Suggested People Events
Lists suggested events for people.
The website identifier
The page number (paging in event list)
Event text
Number of occurences of this event
- GEThttps://api.crisp.chat/v1/website/website_id/people/suggest/events/page_number
- Tiersuserwebsiteplugin
- Scopeswebsite:people:suggest
(loading)
(loading)
Delete Suggested People Event
Deletes a suggested event for people.
The website identifier
Event text to be deleted from suggestions
- DELETEhttps://api.crisp.chat/v1/website/website_id/people/suggest/event
- Tiersuserwebsiteplugin
- Scopeswebsite:people:suggest
(loading)
(loading)
⭐ List People Profiles
Lists people profiles for website.
The website identifier
Page number for people paging
Page size for people paging (between 20 and 50, defaults to 20)
Sort on field (based on available search field names, eg. nickname and more)
Sort order (ascending or descending)
Search operator (or or and respectful to boolean algebra, defaults to and if not set)
Search filter (object filter mapped as string)
Search text (text for a quick search)
When to start relative to profile creation date (date, ISO 8601)
When to end relative to profile creation date (date, ISO 8601)
People identifier
Email for people profile
Personal information
Nickname for user (includes first name and last name)
Avatar for user
Gender for user
Values
malefemale
Phone number for user
Address for user
Description for user
Website of user
Timezone offset of user (UTC)
Online profiles for user
Profile type (eg: facebook, twitter)
User handle on online platform
URL for the profile
Employment information for user
Company name
Company domain name
User title in company
User role in company
User seniority in company
Geolocation information for user
Country code
Region code
City name
Location coordinates
Latitude coordinate
Longitude coordinate
Locales supported by user (ISO 639-1)
Company information
Company name
Company legal name
Company domain name
Company website URL
Company description
Company timezone offset (UTC)
Company phone numbers
Company email addresses
Company location
Country code
Region code
City name
Location coordinates
Latitude coordinate
Longitude coordinate
Metrics for company
Number of employees
Market capitalization
Money raised
Annual Recurring Revenue
Tags for company
Segments attributed to people profile
Private notepad on people profile
User activity statistics (based on last active session from user)
Whether user is considered active right now or not
Timestamp at which the user was last active
Score associated to this profile, from 1 to 5 (based on ratings from user)
Profile creation timestamp
Profile update timestamp
- GEThttps://api.crisp.chat/v1/website/website_id/people/profiles/page_number
- Tiersuserwebsiteplugin
- Scopeswebsite:people:profiles
(loading)
(loading)
⭐ Add New People Profile
Adds a new people profile.
The website identifier
Email for people profile
Personal information
Nickname for user (includes first name and last name)
Avatar for user
Gender for user
Values
malefemale
Phone number for user
Address for user
Description for user
Website of user
Timezone offset of user (UTC)
Online profiles for user
Profile type (eg: facebook, twitter)
User handle on online platform
URL for the profile
Employment information for user
Company name
Company domain name
User title in company
User role in company
User seniority in company
Geolocation information for user
Country code (can be blank)
Region code (can be blank)
City name (can be blank)
Location coordinates
Latitude coordinate
Longitude coordinate
Locales supported by user (ISO 639-1)
Company information
Company name
Company legal name
Company domain name
Company website URL
Company description
Company timezone offset (UTC)
Company phone numbers
Company email addresses
Company location
Country code (can be blank)
Region code (can be blank)
City name (can be blank)
Location coordinates
Latitude coordinate
Longitude coordinate
Metrics for company
Number of employees
Market capitalization
Money raised
Annual Recurring Revenue
Tags for company
Segments attributed to people profile
Private notepad on people profile
Timestamp at which the user was last active
- POSThttps://api.crisp.chat/v1/website/website_id/people/profile
- Tiersuserwebsiteplugin
- Scopeswebsite:people:profiles
(loading)
(loading)
⭐ Check If People Profile Exists
Checks if given people profile exists.
The website identifier
The people identifier (also allowed: people email)
- HEADhttps://api.crisp.chat/v1/website/website_id/people/profile/people_id
- Tiersuserwebsiteplugin
- Scopeswebsite:people:profiles
(loading)
(loading)
⭐ Get People Profile
Resolves people profile.
The website identifier
The people identifier (also allowed: people email)
People identifier
Email for people profile
Personal information
Nickname for user (includes first name and last name)
Avatar for user
Gender for user
Values
malefemale
Phone number for user
Address for user
Description for user
Website of user
Timezone offset of user (UTC)
Online profiles for user
Profile type (eg: facebook, twitter)
User handle on online platform
URL for the profile
Employment information for user
Company name
Company domain name
User title in company
User role in company
User seniority in company
Geolocation information for user
Country code
Region code
City name
Location coordinates
Latitude coordinate
Longitude coordinate
Locales supported by user (ISO 639-1)
Company information
Company name
Company legal name
Company domain name
Company website URL
Company description
Company timezone offset (UTC)
Company phone numbers
Company email addresses
Company location
Country code
Region code
City name
Location coordinates
Latitude coordinate
Longitude coordinate
Metrics for company
Number of employees
Market capitalization
Money raised
Annual Recurring Revenue
Tags for company
Segments attributed to people profile
Private notepad on people profile
User activity statistics (based on last active session from user)
Whether user is considered active right now or not
Timestamp at which the user was last active
Score associated to this profile, from 1 to 5 (based on ratings from user)
Profile creation timestamp
Profile update timestamp
- GEThttps://api.crisp.chat/v1/website/website_id/people/profile/people_id
- Tiersuserwebsiteplugin
- Scopeswebsite:people:profiles
(loading)
(loading)
⭐ Save People Profile
Saves people profile, and overwrite all previous information.
The website identifier
The people identifier (also allowed: people email)
Email for people profile
Personal information
Nickname for user (includes first name and last name)
Avatar for user
Gender for user
Values
malefemale
Phone number for user
Address for user
Description for user
Website of user
Timezone offset of user (UTC)
Online profiles for user
Profile type (eg: facebook, twitter)
User handle on online platform
URL for the profile
Employment information for user
Company name
Company domain name
User title in company
User role in company
User seniority in company
Geolocation information for user
Country code (can be blank)
Region code (can be blank)
City name (can be blank)
Location coordinates
Latitude coordinate
Longitude coordinate
Locales supported by user (ISO 639-1)
Company information
Company name
Company legal name
Company domain name
Company website URL
Company description
Company timezone offset (UTC)
Company phone numbers
Company email addresses
Company location
Country code (can be blank)
Region code (can be blank)
City name (can be blank)
Location coordinates
Latitude coordinate
Longitude coordinate
Metrics for company
Number of employees
Market capitalization
Money raised
Annual Recurring Revenue
Tags for company
Segments attributed to people profile
Private notepad on people profile
Timestamp at which the user was last active
- PUThttps://api.crisp.chat/v1/website/website_id/people/profile/people_id
- Tiersuserwebsiteplugin
- Scopeswebsite:people:profiles
(loading)
(loading)
⭐ Update People Profile
Updates people profile, and save only changed fields on the previous profile revision.
The website identifier
The people identifier (also allowed: people email)
Email for people profile
Personal information
Nickname for user (includes first name and last name)
Avatar for user
Gender for user
Values
malefemale
Phone number for user
Address for user
Description for user
Website of user
Timezone offset of user (UTC)
Online profiles for user
Profile type (eg: facebook, twitter)
User handle on online platform
URL for the profile
Employment information for user
Company name
Company domain name
User title in company
User role in company
User seniority in company
Geolocation information for user
Country code (can be blank)
Region code (can be blank)
City name (can be blank)
Location coordinates
Latitude coordinate
Longitude coordinate
Locales supported by user (ISO 639-1)
Company information
Company name
Company legal name
Company domain name
Company website URL
Company description
Company timezone offset (UTC)
Company phone numbers
Company email addresses
Company location
Country code (can be blank)
Region code (can be blank)
City name (can be blank)
Location coordinates
Latitude coordinate
Longitude coordinate
Metrics for company
Number of employees
Market capitalization
Money raised
Annual Recurring Revenue
Tags for company
Segments attributed to people profile
Private notepad on people profile
Timestamp at which the user was last active
- PATCHhttps://api.crisp.chat/v1/website/website_id/people/profile/people_id
- Tiersuserwebsiteplugin
- Scopeswebsite:people:profiles
(loading)
(loading)
⭐ Remove People Profile
Removes people profile in website.
The website identifier
The people identifier (also allowed: people email)
- DELETEhttps://api.crisp.chat/v1/website/website_id/people/profile/people_id
- Tiersuserwebsiteplugin
- Scopeswebsite:people:profiles
(loading)
(loading)
List People Conversations
Lists conversations linked to people.
The website identifier
The people identifier (also allowed: people email)
The page number (paging in conversation list)
Whether to return only conversations with unread messages (1 or 0, defaults to 0)
Whether to return only conversations that are resolved (1 or 0, defaults to 0)
Whether to return only conversations that are not resolved (1 or 0, defaults to 0)
- GEThttps://api.crisp.chat/v1/website/website_id/people/conversations/people_id/list/page_number
- Tiersuserwebsiteplugin
- Scopeswebsite:people:conversations
(loading)
(loading)
Add A People Event
Stacks an event for people.
The website identifier
The people identifier (also allowed: people email)
Text for event
Data for event (if any)
Color for event (if any)
Values
redorangeyellowgreenbluepurplepinkbrowngreyblack
- POSThttps://api.crisp.chat/v1/website/website_id/people/events/people_id
- Tiersuserwebsiteplugin
- Scopeswebsite:people:events
(loading)
(loading)
List People Events
Lists stacked events for people.
The website identifier
The people identifier (also allowed: people email)
The page number (paging in event list)
Text for event
Data for event (if any)
Color for event (if any)
Values
redorangeyellowgreenbluepurplepinkbrowngreyblack
Timestamp of event (when the event was stacked)
- GEThttps://api.crisp.chat/v1/website/website_id/people/events/people_id/list/page_number
- Tiersuserwebsiteplugin
- Scopeswebsite:people:events
(loading)
(loading)
Get People Data
Gets stored data for people.
The website identifier
The people identifier (also allowed: people email)
People data
- GEThttps://api.crisp.chat/v1/website/website_id/people/data/people_id
- Tiersuserwebsiteplugin
- Scopeswebsite:people:data
(loading)
(loading)
Save People Data
Saves stored data for people. This replaces any already-set data with the new data keys.
The website identifier
The people identifier (also allowed: people email)
People data
- PUThttps://api.crisp.chat/v1/website/website_id/people/data/people_id
- Tiersuserwebsiteplugin
- Scopeswebsite:people:data
(loading)
(loading)
Update People Data
Updates stored data for people. This merges the new data keys with already-set data.
The website identifier
The people identifier (also allowed: people email)
People data
- PATCHhttps://api.crisp.chat/v1/website/website_id/people/data/people_id
- Tiersuserwebsiteplugin
- Scopeswebsite:people:data
(loading)
(loading)
Get People Subscription Status
Resolves subscription status for people (subscribed or unsubscribed).
The website identifier
The people identifier (also allowed: people email)
Whether people is subscribed to emails or not
- GEThttps://api.crisp.chat/v1/website/website_id/people/subscription/people_id
- Tiersuserwebsiteplugin
- Scopeswebsite:people:subscriptions
(loading)
(loading)
Update People Subscription Status
Updates current subscription status for people (subscribe or unsubscribe).
The website identifier
The people identifier (also allowed: people email)
Whether to subscribe to emails or not
- PATCHhttps://api.crisp.chat/v1/website/website_id/people/subscription/people_id
- Tiersuserwebsiteplugin
- Scopeswebsite:people:subscriptions
(loading)
(loading)
Visitorsin Website
Count Visitors
Counts visitors currently on website.
The website identifier
Number of visitors currently on website
Number of active visitors currently on website (those actively browsing)
Whether visitor sockets are limited or not (due to high traffic)
- GEThttps://api.crisp.chat/v1/website/website_id/visitors/count
- Tiersuserwebsiteplugin
- Scopeswebsite:visitors
(loading)
(loading)
List Visitors
Lists visitors currently on website.
The website identifier
Page number for visitors paging
Session identifier for visitor
Inbox identifier for visitor (if any)
Nickname for visitor
Email for visitor
Avatar for visitor
Useragent as advertised by visitor browser
Whether session is initiated or not
Whether the user is actively browsing or not
Last page browsed by visitor
Last page title
Last page URL
Geolocation for visitor
Country code
Region code
City name
Location coordinates
Latitude coordinate
Longitude coordinate
Visitor timezone offset (UTC)
Capabilities of the visitor device
Values
browsingcall
Locales supported by visitor (ISO 639-1)
- GEThttps://api.crisp.chat/v1/website/website_id/visitors/list/page_number
- Tiersuserwebsiteplugin
- Scopeswebsite:visitors
(loading)
(loading)
Pinpoint Visitors On A Map
Maps visitors in a geographical area, given a geographical center and a map radius (defaults to whole Earth if none given). Visitors are grouped in geographical points. There is a static number of points per area (the area is composed of sub-divisions of equal size). Only points which contain visitors are returned.
The map precision increases as the area radius decreases. If there are too many visitors in a given geographical point, an approximate visitors count number will be given.
The website identifier
Area center point latitude
Area center point longitude
Area radius (in kilometers)
Visitors for geographical point
Number of visitors in geographical point
The maximum count number as restricted by the API for calculations (may vary)
Sessions associated to the geographical point
Session identifier for session
Nickname for session
Email for session
Avatar for session
Whether session is initiated or not
Whether the user is actively browsing or not
Last page browsed by session
Last page title
Last page URL
Visitor timezone offset (UTC)
Capabilities of the visitor device
Values
browsingcall
Locales supported by visitor (ISO 639-1)
Geolocation for geographical point
Country code
Region code
City name
Location coordinates
Latitude coordinate
Longitude coordinate
- GEThttps://api.crisp.chat/v1/website/website_id/visitors/map
- Tiersuserwebsiteplugin
- Scopeswebsite:visitors
(loading)
(loading)
Get Session Identifier From Token
Transforms a token to a session identifier, if any session is bound to the token. The token can be bound to a session from the Crisp chatbox.
The website identifier
The token identifier
Session identifier
Token value
- GEThttps://api.crisp.chat/v1/website/website_id/visitors/token/token_id
- Tiersuserwebsiteplugin
- Scopeswebsite:visitors
(loading)
(loading)
Availabilityin Website
Get Website Availability Status
Resolves the website availability status. This tells whether the chatbox is seen as online or away by visitors.
The availability status is set to online if at least one operator can be seen as online (given his account availability settings).
The website identifier
Availability status
Values
onlineawayoffline
Timestamp since when the availability has been updated
- GEThttps://api.crisp.chat/v1/website/website_id/availability/status
- Tiersuserwebsiteplugin
- Scopeswebsite:availability
(loading)
(loading)
List Website Operator Availabilities
Lists the availabilities for website operators. This maps the availability of each operator in the website.
The website identifier
User identifier
Availability type
Values
onlineawayoffline
Seconds for which the availability is valid
Timestamp since when the availability has been updated
- GEThttps://api.crisp.chat/v1/website/website_id/availability/operators
- Tiersuserwebsiteplugin
- Scopeswebsite:availability
(loading)
(loading)
Operatorsin Website
List Website Operators
Lists all operator members of website.
The website identifier
Member type (invite means the operator did not join yet, sandbox stands for a plugin developer from Crisp Marketplace)
Values
operatorinvitesandbox
Member details
User identifier (for operator and sandbox types only)
User email (for all types)
User avatar (for operator type only)
User first name (for operator and sandbox types only)
User last name (for operator and sandbox types only)
User role (for operator and invite types only)
Values
ownermember
User title (if any, for operator type only)
User availability (for operator type only)
Values
onlineawayoffline
Whether operator has Two Factor Authentication enabled or not (for operator type only)
User invite identifier (for invite type only, only visible to owners)
User invite key (for invite type only, only visible to owners)
- GEThttps://api.crisp.chat/v1/website/website_id/operators/list
- Tiersuserwebsiteplugin
- Scopeswebsite:operators
(loading)
(loading)
List Last Active Website Operators
Lists last active website operators, ie. operators who last replied to a visitor message.
The website identifier
Operator user identifier
Operator avatar
Operator nickname
Timestamp at which operator was last active
- GEThttps://api.crisp.chat/v1/website/website_id/operators/active
- Tiersuserwebsiteplugin
- Scopeswebsite:operators
(loading)
(loading)
Send Email To Website Operators
Sends an email to target website operators. The email will be delivered to each operator account email address.
The website identifier
Recipient type
Values
allownersmembersuser
Recipient user identifier (if recipient is user)
Email subject
Email message body
Target button
Target button label
Target button URL
- POSThttps://api.crisp.chat/v1/website/website_id/operators/email
- Tiersuserwebsiteplugin
- Scopeswebsite:operators
(loading)
(loading)
Operatorin Website
Get A Website Operator
Resolves a given website operator.
The website identifier
The user identifier for operator
User identifier
User email
User avatar
User first name
User last name
User role
Values
ownermember
User title (if any)
User availability
Values
onlineawayoffline
Whether operator has Two Factor Authentication enabled or not
- GEThttps://api.crisp.chat/v1/website/website_id/operator/user_id
- Tiersuserwebsiteplugin
- Scopeswebsite:operators
(loading)
(loading)
Teamsin Website
List Teams
Lists teams for website.
The website identifier
Page number for teams paging
Team identifier
Team name
Team emoji
User identifiers of team operators
Team creation timestamp
Team update timestamp
- GEThttps://api.crisp.chat/v1/website/website_id/teams/list/page_number
- Tiersuserwebsiteplugin
(loading)
(loading)
Teamin Website
Check If Team Exists
Checks if given team exists.
The website identifier
The team identifier
- HEADhttps://api.crisp.chat/v1/website/website_id/team/team_id
- Tiersuserwebsiteplugin
(loading)
(loading)
Get A Team
Resolves team information.
The website identifier
The team identifier
Team identifier
Team name
Team emoji
User identifiers of team operators
Team creation timestamp
Team update timestamp
- GEThttps://api.crisp.chat/v1/website/website_id/team/team_id
- Tiersuserwebsiteplugin
(loading)
(loading)
Helpdeskin Website
Check If Helpdesk Exists
Checks if helpdesk exists for website (ie. if it has been initialized).
The website identifier
- HEADhttps://api.crisp.chat/v1/website/website_id/helpdesk
- Tiersuserwebsiteplugin
- Scopeswebsite:helpdesk:identity
(loading)
(loading)
Resolve Helpdesk
Resolves helpdesk information for website.
The website identifier
Name of the helpdesk
Public URL of the helpdesk
- GEThttps://api.crisp.chat/v1/website/website_id/helpdesk
- Tiersuserwebsiteplugin
- Scopeswebsite:helpdesk:identity
(loading)
(loading)
List Helpdesk Locales
Lists locales for helpdesk in website.
The website identifier
Page number for locales paging
Locale identifier
Locale code for helpdesk (ISO 639-1)
Public URL of the helpdesk for locale
Content statistics by helpdesk content type
Articles statistics
Number of article entries
Number of article groups (categories & sections)
Guides statistics
Number of guide entries
Number of guide groups
References statistics
Number of reference entries
Number of reference groups
News statistics
Number of news entries
Number of news groups
- GEThttps://api.crisp.chat/v1/website/website_id/helpdesk/locales/page_number
- Tiersuserwebsiteplugin
- Scopeswebsite:helpdesk:locales
(loading)
(loading)
Add Helpdesk Locale
Adds a locale for helpdesk in website.
The website identifier
Locale code for helpdesk to add (ISO 639-1)
- POSThttps://api.crisp.chat/v1/website/website_id/helpdesk/locale
- Tiersuserwebsiteplugin
- Scopeswebsite:helpdesk:locales
(loading)
(loading)
Check If Helpdesk Locale Exists
Checks if a helpdesk locale exists for helpdesk in website.
The website identifier
The locale code
- HEADhttps://api.crisp.chat/v1/website/website_id/helpdesk/locale/locale
- Tiersuserwebsiteplugin
- Scopeswebsite:helpdesk:locales
(loading)
(loading)
Resolve Helpdesk Locale
Resolves a locale for helpdesk in website.
The website identifier
The locale code
Locale identifier
Locale code for helpdesk (ISO 639-1)
Public URL of the helpdesk for locale
Content statistics by helpdesk content type
Articles statistics
Number of article entries
Number of article groups (categories & sections)
Guides statistics
Number of guide entries
Number of guide groups
References statistics
Number of reference entries
Number of reference groups
News statistics
Number of news entries
Number of news groups
- GEThttps://api.crisp.chat/v1/website/website_id/helpdesk/locale/locale
- Tiersuserwebsiteplugin
- Scopeswebsite:helpdesk:locales
(loading)
(loading)
Delete Helpdesk Locale
Deletes a locale for helpdesk in website.
The website identifier
The locale code
- DELETEhttps://api.crisp.chat/v1/website/website_id/helpdesk/locale/locale
- Tiersuserwebsiteplugin
- Scopeswebsite:helpdesk:locales
(loading)
(loading)
Map Helpdesk Locale Feedback Ratings
Map locale feedback ratings for helpdesk in website.
The website identifier
The locale code
The helpdesk content type
Values
articlesguidesreferencesnews
When to start relative to feedback creation date (date, ISO 8601)
When to end relative to feedback creation date (date, ISO 8601)
Ratings map
Number of helpful ratings left
Number of unhelpful ratings left
- GEThttps://api.crisp.chat/v1/website/website_id/helpdesk/feedback/ratings/locale/type
- Tiersuserwebsiteplugin
- Scopeswebsite:helpdesk:feedbacks
(loading)
(loading)
List Helpdesk Locale Feedbacks
Lists locale feedbacks for helpdesk in website.
The website identifier
The locale code
The helpdesk content type
Values
articlesguidesreferencesnews
The page number (paging in feedbacks list)
When to start relative to feedback creation date (date, ISO 8601)
When to end relative to feedback creation date (date, ISO 8601)
Rating for feedback
Values
helpfulunhelpful
Comment left for feedback (if any)
Article associated to feedback
Article identifier
Title of the article
Public URL of the article (if status is published)
Feedback author (if any)
Session identifier for feedback author
Nickname for feedback author
Email for feedback author
Avatar for feedback author
Geolocation for feedback author
Country code
Region code
City name
Location coordinates
Latitude coordinate
Longitude coordinate
Assigned operator (if any)
Operator user identifier
Feedback creation timestamp
- GEThttps://api.crisp.chat/v1/website/website_id/helpdesk/feedback/list/locale/type/page_number
- Tiersuserwebsiteplugin
- Scopeswebsite:helpdesk:feedbacks
(loading)
(loading)
List Helpdesk Pages
Lists publicly visible Helpdesk pages for a locale, providing their URLs (the pages must be published).
The website identifier
The locale code
The helpdesk content type
Values
articlesguidesreferencesnews
The page number (paging in pages list)
Content entity identifier
Content page title
Content file path in tree path
Public URL of the content page
- GEThttps://api.crisp.chat/v1/website/website_id/helpdesk/page/list/locale/type/page_number
- Tiersuserwebsiteplugin
- Scopeswebsite:helpdesk:articles
(loading)
(loading)
Resolve Helpdesk Page Entity
Resolves a publicly visible Helpdesk page by entity identifier, providing its public URL (the page must be published).
The website identifier
The locale code
The helpdesk content type
Values
articlesguidesreferencesnews
The content entity identifier
Content entity identifier
Content page title
Content file path in tree path
Public URL of the content page
- GEThttps://api.crisp.chat/v1/website/website_id/helpdesk/page/entity/locale/type/entity_id
- Tiersuserwebsiteplugin
- Scopeswebsite:helpdesk:articles
(loading)
(loading)
List Helpdesk Tree
Lists Helpdesk tree entries for a locale and content type.
Set sub_path to list from a sub-directory.
The website identifier
The locale code
The helpdesk content type
Values
articlesguidesreferencesnews
The page number (paging in content tree entries)
Tree subdirectory path to list (defaults to /)
Title text to search for
Filter entries by status
Values
visiblehiddendraftfeatured
When to start relative to entry update date (date, ISO 8601)
When to end relative to entry update date (date, ISO 8601)
Tree entry type
Values
filedirectory
Tree entry slug
Whether the entry has an explicit position in its directory order
Tree entry title
Content state fields available for the entry
Child entries (if type is directory — data schema is the same as the parent)
- GEThttps://api.crisp.chat/v1/website/website_id/helpdesk/tree/list/locale/type/page_number
- Tiersuserwebsiteplugin
- Scopeswebsite:helpdesk:articles
(loading)
(loading)
Create Helpdesk Tree Path
Creates an empty Helpdesk file or directory metadata path.
The website identifier
The locale code
The helpdesk content type
Values
articlesguidesreferencesnews
The tree path
- POSThttps://api.crisp.chat/v1/website/website_id/helpdesk/tree/path/locale/type/path
- Tiersuserwebsiteplugin
(loading)
(loading)
Resolve Helpdesk Tree Path
Resolves a Helpdesk tree entry.
The website identifier
The locale code
The helpdesk content type
Values
articlesguidesreferencesnews
The tree path
Tree entry type
Values
filedirectory
Tree entry slug
Tree entry title
Content state fields available for the entry
Child entries (if type is directory — data schema is the same as the parent)
- GEThttps://api.crisp.chat/v1/website/website_id/helpdesk/tree/path/locale/type/path
- Tiersuserwebsiteplugin
- Scopeswebsite:helpdesk:articles
(loading)
(loading)
Update Helpdesk Tree Path
Moves a tree path or changes its display order.
The website identifier
The locale code
The helpdesk content type
Values
articlesguidesreferencesnews
The tree path
Requested path operation
Values
moveorder
Destination path for move action
Destination tree path
Display position for order action (set -1 to unset the position)
- PATCHhttps://api.crisp.chat/v1/website/website_id/helpdesk/tree/path/locale/type/path
- Tiersuserwebsiteplugin
(loading)
(loading)
Delete Helpdesk Tree Path
Deletes a Helpdesk tree path recursively.
The website identifier
The locale code
The helpdesk content type
Values
articlesguidesreferencesnews
The tree path
- DELETEhttps://api.crisp.chat/v1/website/website_id/helpdesk/tree/path/locale/type/path
- Tiersuserwebsiteplugin
(loading)
(loading)
Resolve Helpdesk Tree Content
Resolves the body content of a Helpdesk tree file.
The website identifier
The locale code
The helpdesk content type
Values
articlesguidesreferencesnews
The tree file path
Content file body
- GEThttps://api.crisp.chat/v1/website/website_id/helpdesk/tree/content/locale/type/path
- Tiersuserwebsiteplugin
- Scopeswebsite:helpdesk:articles
(loading)
(loading)
Save Helpdesk Tree Content
Replaces the body content of a Helpdesk tree file.
The website identifier
The locale code
The helpdesk content type
Values
articlesguidesreferencesnews
The tree file path
Content file body
- PUThttps://api.crisp.chat/v1/website/website_id/helpdesk/tree/content/locale/type/path
- Tiersuserwebsiteplugin
(loading)
(loading)
Resolve Helpdesk Tree Metadata
Resolves parsed metadata for a Helpdesk tree file or directory.
The website identifier
The locale code
The helpdesk content type
Values
articlesguidesreferencesnews
The tree path
Metadata format
Values
articlescategoriessections
Content title
Content description
Content state (if supported for format)
Whether content is published (if articles)
Whether content is hidden (if articles)
Whether content is featured (if articles)
Content author (if articles)
User identifier of the author
Color for content (if categories)
Content image URL (if categories)
- GEThttps://api.crisp.chat/v1/website/website_id/helpdesk/tree/metadata/locale/type/path
- Tiersuserwebsiteplugin
- Scopeswebsite:helpdesk:articles
(loading)
(loading)
Update Helpdesk Tree Metadata
Updates metadata for an article, category, or section tree entry. A publishable entry (eg. articles) must have non-empty content before it can be published.
The website identifier
The locale code
The helpdesk content type
Values
articlesguidesreferencesnews
The tree path
Metadata format
Values
articlescategoriessections
Content title
Content description
Content state (if supported for format)
Whether content is published (if articles)
Whether content is hidden (if articles)
Whether content is featured (if articles)
Content author (if articles)
User identifier of the author
Color for content (if categories)
Content image URL (if categories)
- PATCHhttps://api.crisp.chat/v1/website/website_id/helpdesk/tree/metadata/locale/type/path
- Tiersuserwebsiteplugin
(loading)
(loading)
List Helpdesk Tree Alternates
Lists alternate locale tree paths linked to a Helpdesk tree entry.
The website identifier
The source locale code
The helpdesk content type
Values
articlesguidesreferencesnews
The tree path
Alternate tree paths, by target locale code
- GEThttps://api.crisp.chat/v1/website/website_id/helpdesk/tree/alternates/locale/type/path
- Tiersuserwebsiteplugin
- Scopeswebsite:helpdesk:articles
(loading)
(loading)
Update Helpdesk Tree Alternates
Creates or updates alternate locale links for a Helpdesk tree entry. Each request body property is a target locale code and its value is the target tree path.
Set a value to null to remove its existing alternate link. Alternate links are maintained in both directions.
The website identifier
The source locale code
The helpdesk content type
Values
articlesguidesreferencesnews
The source tree path
Target tree path for this locale (or null to remove the alternate link)
- PATCHhttps://api.crisp.chat/v1/website/website_id/helpdesk/tree/alternates/locale/type/path
- Tiersuserwebsiteplugin
(loading)
(loading)
Resolve Helpdesk Tree Page
Resolves a Helpdesk content page title and its public URL, when published and visible.
The website identifier
The locale code
The helpdesk content type
Values
articlesguidesreferencesnews
The tree file path
Content page title
Public content page URL (if published and not hidden)
- GEThttps://api.crisp.chat/v1/website/website_id/helpdesk/tree/page/locale/type/path
- Tiersuserwebsiteplugin
- Scopeswebsite:helpdesk:articles
(loading)
(loading)
List Helpdesk Redirections
Lists redirections for helpdesk in website.
The website identifier
Page number for redirections paging
Redirection identifier
Redirection source path
Redirection destination target path
Redirection creation timestamp
Redirection update timestamp
- GEThttps://api.crisp.chat/v1/website/website_id/helpdesk/redirections/page_number
- Tiersuserwebsiteplugin
- Scopeswebsite:helpdesk:redirections
(loading)
(loading)
Add Helpdesk Redirection
Adds a redirection for helpdesk in website.
The website identifier
Redirection source path
Redirection destination target path
- POSThttps://api.crisp.chat/v1/website/website_id/helpdesk/redirection
- Tiersuserwebsiteplugin
- Scopeswebsite:helpdesk:redirections
(loading)
(loading)
Check If Helpdesk Redirection Exists
Checks if a helpdesk redirection exists for helpdesk in website.
The website identifier
The redirection identifier
- HEADhttps://api.crisp.chat/v1/website/website_id/helpdesk/redirection/redirection_id
- Tiersuserwebsiteplugin
- Scopeswebsite:helpdesk:redirections
(loading)
(loading)
Resolve Helpdesk Redirection
Resolves a redirection for helpdesk in website.
The website identifier
The redirection identifier
Redirection identifier
Redirection source path
Redirection destination target path
Redirection creation timestamp
Redirection update timestamp
- GEThttps://api.crisp.chat/v1/website/website_id/helpdesk/redirection/redirection_id
- Tiersuserwebsiteplugin
- Scopeswebsite:helpdesk:redirections
(loading)
(loading)
Delete Helpdesk Redirection
Deletes a redirection for helpdesk in website.
The website identifier
The redirection identifier
- DELETEhttps://api.crisp.chat/v1/website/website_id/helpdesk/redirection/redirection_id
- Tiersuserwebsiteplugin
- Scopeswebsite:helpdesk:redirections
(loading)
(loading)
Resolve Helpdesk Settings
Resolves settings for helpdesk in website.
The website identifier
Name of the helpdesk
Appearance configuration of the helpdesk
Color mode configuration
Active color mode
Values
chatboxautolightdark
Whether visitors can change the color mode
Logos of the helpdesk
Favicon URL (if any)
Header logo URL (if any)
Footer logo URL (if any)
Banner image URL (if any)
Localization configuration of the helpdesk
Default locale used to write helpdesk content
Whether helpdesk content is translated automatically
Whether translated locales are read-only
Visibility configuration for helpdesk content sections
Articles section visibility
Values
automaticenableddisabledhidden
Guides section visibility
Values
automaticenableddisabledhidden
References section visibility
Values
automaticenableddisabledhidden
News section visibility
Values
automaticenableddisabledhidden
Behavior configuration of the helpdesk
Whether to show frequently read articles on homepage or not
Whether to show category images on homepage or not
Whether to show chatbox on helpdesk or not
Whether to ask for user feedback at the end of articles or not
Whether to serve helpdesk content as Markdown
Whether to show an AI answer copy button
Whether to show a table of contents on content pages
Whether to show a locale picker in header or not
Whether to show a link to Crisp in the footer of the helpdesk or not
Whether to forbid search engine indexing of all helpdesk pages
Whether to show status banner, when status page reports as dead (if Status Page plugin is used)
Helpdesk service configuration
Whether to enable the MCP server
Include configuration for the helpdesk
Raw HTML include (if any)
Access restrictions for the helpdesk
Access restriction mode
Values
nonepasswordjwt
Password requested to access the helpdesk (if any)
JWT secret used to access the helpdesk (if any)
JWT authentication URL to redirect user to (if any)
- GEThttps://api.crisp.chat/v1/website/website_id/helpdesk/settings
- Tiersuserwebsiteplugin
- Scopeswebsite:helpdesk:settings
(loading)
(loading)
Save Helpdesk Settings
Saves settings for helpdesk in website.
The website identifier
Name of the helpdesk
Appearance configuration of the helpdesk
Color mode configuration
Active color mode
Values
chatboxautolightdark
Whether visitors can change the color mode
Logos of the helpdesk
Favicon URL (can be blank)
Header logo URL (can be blank)
Footer logo URL (can be blank)
Banner image URL (can be blank)
Localization configuration of the helpdesk
Default locale used to write helpdesk content
Whether helpdesk content is translated automatically
Whether translated locales are read-only
Visibility configuration for helpdesk content sections
Articles section visibility
Values
automaticenableddisabledhidden
Guides section visibility
Values
automaticenableddisabledhidden
References section visibility
Values
automaticenableddisabledhidden
News section visibility
Values
automaticenableddisabledhidden
Behavior configuration of the helpdesk
Whether to show frequently read articles on homepage or not
Whether to show category images on homepage or not
Whether to show chatbox on helpdesk or not
Whether to ask for user feedback at the end of articles or not
Whether to serve helpdesk content as Markdown
Whether to show an AI answer copy button
Whether to show a table of contents on content pages
Whether to show a locale picker in header or not
Whether to show a link to Crisp in the footer of the helpdesk or not
Whether to forbid search engine indexing of all helpdesk pages
Whether to show status banner, when status page reports as dead (if Status Page plugin is used)
Helpdesk service configuration
Whether to enable the MCP server
Include configuration for the helpdesk
Raw HTML include (if any)
Access restrictions for the helpdesk
Access restriction mode
Values
nonepasswordjwt
Password requested to access the helpdesk (if any)
JWT authentication URL to redirect user to (if any)
- PATCHhttps://api.crisp.chat/v1/website/website_id/helpdesk/settings
- Tiersuserwebsiteplugin
- Scopeswebsite:helpdesk:settings
(loading)
(loading)
Campaignsin Website
List Campaign Templates
Lists campaign templates for website.
The website identifier
Page number for templates paging
Search by template name
Filter by template static type (1 or 0)
Filter by template custom type (1 or 0)
Template identifier
Template type
Values
staticcustom
Template name
Template format
Values
markdownhtml
Template creation timestamp
Template update timestamp
- GEThttps://api.crisp.chat/v1/website/website_id/campaigns/templates/page_number
- Tiersuserwebsiteplugin
- Scopeswebsite:campaign:templates
(loading)
(loading)
Create A New Campaign Template
Creates a new campaign template.
The website identifier
Template name
Template format
Values
markdownhtml
- POSThttps://api.crisp.chat/v1/website/website_id/campaigns/template
- Tiersuserwebsiteplugin
- Scopeswebsite:campaign:templates
(loading)
(loading)
Check If Campaign Template Exists
Checks if given campaign template exists.
The website identifier
The template identifier
- HEADhttps://api.crisp.chat/v1/website/website_id/campaigns/template/template_id
- Tiersuserwebsiteplugin
- Scopeswebsite:campaign:templates
(loading)
(loading)
Get A Campaign Template
Resolves campaign template information.
The website identifier
The template identifier
Template identifier
Template type
Values
staticcustom
Template name
Template format
Values
markdownhtml
Template content
Template creation timestamp
Template update timestamp
- GEThttps://api.crisp.chat/v1/website/website_id/campaigns/template/template_id
- Tiersuserwebsiteplugin
- Scopeswebsite:campaign:templates
(loading)
(loading)
Save A Campaign Template
Saves a campaign template in website, and overwrite previous template information.
The website identifier
The template identifier
Template name
Template format
Values
markdownhtml
Template content
- PUThttps://api.crisp.chat/v1/website/website_id/campaigns/template/template_id
- Tiersuserwebsiteplugin
- Scopeswebsite:campaign:templates
(loading)
(loading)
Update A Campaign Template
Updates a campaign template in website, and save only changed fields.
The website identifier
The template identifier
Template name
Template format
Values
markdownhtml
Template content
- PATCHhttps://api.crisp.chat/v1/website/website_id/campaigns/template/template_id
- Tiersuserwebsiteplugin
- Scopeswebsite:campaign:templates
(loading)
(loading)
Remove A Campaign Template
Removes a campaign template in website.
The website identifier
The template identifier
- DELETEhttps://api.crisp.chat/v1/website/website_id/campaigns/template/template_id
- Tiersuserwebsiteplugin
- Scopeswebsite:campaign:templates
(loading)
(loading)
Analyticsin Website
Generate Analytics
Generates analytics for given type and metric in website.
The website identifier
Analytics metric
Values
conversationconversation_assignedconversation_shortcutconversation_segmentconversation_statehelpdesk_readhelpdesk_searchvisitor_visitvisitor_triggercampaign_activitycampaign_sentpeople_createdstatus_downtimemessage
Analytics type (depends on metric value)
Values
totaluniqueresponse_timeresolution_timehandle_timemessagesvisitor_messagesoperator_messagesratingoperator
Analytics aggregator
Values
averagemoving_averagemedianminimummaximumsum
Split by key
Filter options (generic, based on metric value)
Date parameters
Date from range (ISO 8601)
Date to range (ISO 8601)
Date split
Values
allhourlydailyweeklymonthlyyearly
Date timezone (eg. Europe/Paris)
Date days
Monday hour range
Hour from range (eg. 11:30)
Hour to range (eg. 14:00)
Tuesday hour range
Hour from range (eg. 11:30)
Hour to range (eg. 14:00)
Wednesday hour range
Hour from range (eg. 11:30)
Hour to range (eg. 14:00)
Thursday hour range
Hour from range (eg. 11:30)
Hour to range (eg. 14:00)
Friday hour range
Hour from range (eg. 11:30)
Hour to range (eg. 14:00)
Saturday hour range
Hour from range (eg. 11:30)
Hour to range (eg. 14:00)
Sunday hour range
Hour from range (eg. 11:30)
Hour to range (eg. 14:00)
If condition (then needs to be also set)
Analytics metric (for condition)
Values
conversation
Split by key (for condition)
Then action (if needs to be also set)
Filter type (for action, depends on metric value in condition)
Values
totaluniquerating
Filter options (for action, based on metric value in condition)
Whether to export data in raw format
- POSThttps://api.crisp.chat/v1/website/website_id/analytics/generate
- Tiersuserwebsiteplugin
- Scopeswebsite:analytics
(loading)
(loading)
Inboxin Website
List Website Inboxes
Lists all inboxes for website.
The website identifier
The page number (paging in inbox list)
Inbox identifier
Inbox name
Inbox emoji
Inbox order
Operator user identifiers (members of the inbox)
Team identifiers (members of the inbox)
Operator user identifiers expanded from teams
Boolean operator used on conditions
Values
andor
Filtering conditions
Filter model
Values
session
Filter criterion (in model)
Filter operator
Values
eqneqgteltegtlt
Filter query terms
Inbox creation timestamp
Inbox update timestamp
- GEThttps://api.crisp.chat/v1/website/website_id/inboxes/list/page_number
- Tiersuserwebsiteplugin
- Scopeswebsite:inboxes
(loading)
(loading)
Check If Website Inbox Exists
Checks if inbox exists for website.
The website identifier
The inbox identifier
- HEADhttps://api.crisp.chat/v1/website/website_id/inbox/inbox_id
- Tiersuserwebsiteplugin
- Scopeswebsite:inboxes
(loading)
(loading)
Get Website Inbox
Resolves inbox for website.
The website identifier
The inbox identifier
Inbox identifier
Inbox name
Inbox emoji
Inbox order
Operator user identifiers (members of the inbox)
Team identifiers (members of the inbox)
Operator user identifiers expanded from teams
Boolean operator used on conditions
Values
andor
Filtering conditions
Filter model
Values
session
Filter criterion (in model)
Filter operator
Values
eqneqgteltegtlt
Filter query terms
Inbox creation timestamp
Inbox update timestamp
- GEThttps://api.crisp.chat/v1/website/website_id/inbox/inbox_id
- Tiersuserwebsiteplugin
- Scopeswebsite:inboxes
(loading)
(loading)
Settingsin Website
Get Website Settings
Resolves the current settings for a website.
The website identifier
Website identifier
Website name
Website domain
Alternate website domains (can be blank)
Website custom logo image URL (can be blank)
Website auditing settings
Whether audit log is enabled or not
Website contact information
Contact email (can be blank)
Contact phone number (can be blank)
Contact handle on Messenger (can be blank)
Contact handle on Telegram (can be blank)
Contact handle on Twitter (can be blank)
Contact number on WhatsApp (can be blank)
Contact handle on Instagram (can be blank)
Inbox settings
Whether to prevent non-owner operators to remove data or not
Whether to force operators to use Two Factor Authentication or not
Which locale to use as default for inbox resources, such as sent emails (when the target user locale is not known, can be blank if none, ISO 639-1)
Emails settings
Whether to ask users to rate support or not
Whether to notify users of transcript records for conversation or not
Whether to track email open and click events or not
Whether to enable the junk filter or not
Chatbox settings
Which tile to use for messages view background in chatbox (set to blank value for none)
Values
defaultshapes4-point-starsanchors-awayautumnaztecbamboobank-notebathroom-floorbevel-circleboxesbrick-wallbubblescagecharlie-brownchurch-on-sundaycircles-and-squarescircuit-boardconnectionscork-screwcurrentcurtaindeath-stardiagonal-linesdiagonal-stripesdominosendless-cloudseyesfalling-trianglesfancy-rectanglesflipped-diamondsfloating-cogsfloor-tileglamorousgraph-papergroovyhappy-intersectionheavy-rainhexagonshideouthoundstoothi-like-foodintersecting-circleskiwileafline-in-motionlipslisbonmeltmoroccanmorphing-diamondsoverlapping-circlesoverlapping-diamondsoverlapping-hexagonsparkay-floorpiano-manpie-factorypixel-dotspluspolka-dotsrailsrainrandom-shapesrounded-plus-connectedsignalskullsslanted-starssquares-in-squaressquaresstamp-collectionsteel-beamsstripestempletic-tac-toetiny-checkersvolcano-lampwallpaperwigglex-equalsyyyzig-zag
Whether to enable multi-conversation mode (allowing users to create multiple conversations)
Whether to suggest user to play a wait game or not (if operators do not reply fast enough)
Whether to show website logo in chatbox button or not
Whether to show last operator face in chatbox button or not
Whether to show ongoing operator face in chatbox button or not
Whether to show activity metrics in chatbox or not
Whether to enable operator privacy options or not
Whether to enable visitor privacy options or not (Total Privacy™ mode)
Whether to show availability tooltip or not
Whether to place website support in vacation or not (this hides the chatbox)
Whether to hide chatbox on away or not
Whether to hide chatbox on mobile devices or not
Whether reverse chatbox position or not
Whether to ask for visitor email or not
Whether to ask for visitor phone or not
Whether to force visitor to identify or not (requires at least email or phone ask enabled)
Whether to disable privacy filters and ignore user choices (eg. user Do Not Track value)
Whether to show visitor compose preview or not (MagicType from visitor)
Whether to show the file upload control in chatbox
Whether to show the audio recording control in chatbox
Which anti-bot guard level to use for the chatbox
Values
defaultlowmediumhighextreme
Which section to show by default when opening the chatbox
Values
homechathelpdesk
Whether to show the chatbox home section
Whether to show a button to search in all support resources via Crisp Overlay
Whether to restrict the chatbox to show search via Crisp Overlay before the user can contact support
Whether to show a link to helpdesk in chatbox (if helpdesk is configured)
Whether to restrict the chatbox to show the helpdesk view only, and disable chat (if helpdesk is configured)
Helpdesk navigation mode in the chatbox (can be a deep navigation showing categories, then sections, then articles; or only frequently-read articles)
Values
deepfrequent
Whether to show status banner, when status page reports as dead (if Status Page plugin is used)
Whether to check website domain before creating sessions or not
Which color theme to use
Values
defaultamberblackblueblue_greylight_bluebrowncyangreenlight_greengreyindigoorangedeep_orangepinkpurpledeep_purpleredteal
Which color mode to use
Values
lightdarkauto
Which layout theme to use
Values
defaultcolorized
Which text theme to use
Values
default1234
Which welcome message to display on chatbox open
Values
default12345
Which locale to enforce (can be blank for auto-detect, ISO 639-1)
Allowed pages (chatbox is visible only for those page URLs)
Blocked pages (chatbox is hidden for those page URLs)
Blocked countries (chatbox is hidden for those countries)
Blocked locales (chatbox is hidden for those locales, ISO 639-1)
Blocked IP addresses (chatbox is hidden for those IPs: IPv4 or IPv6, CIDR)
- GEThttps://api.crisp.chat/v1/website/website_id/settings
- Tiersuserwebsiteplugin
- Scopeswebsite:settings
(loading)
(loading)
Update Website Settings
Updates the current settings for a website.
The website identifier
Website name
Website domain
Alternate website domains (can be blank)
Website custom logo image URL (can be blank)
Website auditing settings
Whether audit log is enabled or not
Website contact information
Contact email (can be blank)
Contact phone number (can be blank)
Contact handle on Messenger (can be blank)
Contact handle on Telegram (can be blank)
Contact handle on Twitter (can be blank)
Contact number on WhatsApp (can be blank)
Contact handle on Instagram (can be blank)
Inbox settings
Whether to prevent non-owner operators to remove data or not
Whether to force operators to use Two Factor Authentication or not
Which locale to use as default for inbox resources, such as sent emails (when the target user locale is not known, can be blank if none, ISO 639-1)
Emails settings
Whether to ask users to rate support or not
Whether to notify users of transcript records for conversation or not
Whether to track email open and click events or not
Whether to enable the junk filter or not
Chatbox settings
Which tile to use for messages view background in chatbox (set to blank value for none)
Values
defaultshapes4-point-starsanchors-awayautumnaztecbamboobank-notebathroom-floorbevel-circleboxesbrick-wallbubblescagecharlie-brownchurch-on-sundaycircles-and-squarescircuit-boardconnectionscork-screwcurrentcurtaindeath-stardiagonal-linesdiagonal-stripesdominosendless-cloudseyesfalling-trianglesfancy-rectanglesflipped-diamondsfloating-cogsfloor-tileglamorousgraph-papergroovyhappy-intersectionheavy-rainhexagonshideouthoundstoothi-like-foodintersecting-circleskiwileafline-in-motionlipslisbonmeltmoroccanmorphing-diamondsoverlapping-circlesoverlapping-diamondsoverlapping-hexagonsparkay-floorpiano-manpie-factorypixel-dotspluspolka-dotsrailsrainrandom-shapesrounded-plus-connectedsignalskullsslanted-starssquares-in-squaressquaresstamp-collectionsteel-beamsstripestempletic-tac-toetiny-checkersvolcano-lampwallpaperwigglex-equalsyyyzig-zag
Whether to enable multi-conversation mode (allowing users to create multiple conversations)
Whether to suggest user to play a wait game or not (if operators do not reply fast enough)
Whether to show website logo in chatbox button or not
Whether to show last operator face in chatbox button or not
Whether to show ongoing operator face in chatbox button or not
Whether to show activity metrics in chatbox or not
Whether to enable operator privacy options or not
Whether to enable visitor privacy options or not (Total Privacy™ mode)
Whether to show availability tooltip or not
Whether to place website support in vacation or not (this hides the chatbox)
Whether to hide chatbox on away or not
Whether to hide chatbox on mobile devices or not
Whether reverse chatbox position or not
Whether to ask for visitor email or not
Whether to ask for visitor phone or not
Whether to force visitor to identify or not (requires at least email or phone ask enabled)
Whether to disable privacy filters and ignore user choices (eg. user Do Not Track value)
Whether to show visitor compose preview or not (MagicType from visitor)
Whether to show the file upload control in chatbox
Whether to show the audio recording control in chatbox
Which anti-bot guard level to use for the chatbox
Values
defaultlowmediumhighextreme
Which section to show by default when opening the chatbox
Values
homechathelpdesk
Whether to show the chatbox home section
Whether to show a button to search in all support resources via Crisp Overlay
Whether to restrict the chatbox to show search via Crisp Overlay before the user can contact support
Whether to show a link to helpdesk in chatbox (if helpdesk is configured)
Whether to restrict the chatbox to show the helpdesk view only, and disable chat (if helpdesk is configured)
Helpdesk navigation mode in the chatbox (can be a deep navigation showing categories, then sections, then articles; or only frequently-read articles)
Values
deepfrequent
Whether to show status banner, when status page reports as dead (if Status Page plugin is used)
Whether to check website domain before creating sessions or not
Which color theme to use
Values
defaultamberblackblueblue_greylight_bluebrowncyangreenlight_greengreyindigoorangedeep_orangepinkpurpledeep_purpleredteal
Which color mode to use
Values
lightdarkauto
Which layout theme to use
Values
defaultcolorized
Which text theme to use
Values
default1234
Which welcome message to display on chatbox open
Values
default12345
Which locale to enforce (can be blank for auto-detect, ISO 639-1)
Allowed pages (chatbox is visible only for those page URLs)
Blocked pages (chatbox is hidden for those page URLs)
Blocked countries (chatbox is hidden for those countries)
Blocked locales (chatbox is hidden for those locales, ISO 639-1)
Blocked IP addresses (chatbox is hidden for those IPs: IPv4 or IPv6, CIDR)
- PATCHhttps://api.crisp.chat/v1/website/website_id/settings
- Tiersuserwebsiteplugin
- Scopeswebsite:settings
(loading)
(loading)
Verifyin Website
Get Verify Settings
Resolves verify settings.
The website identifier
Whether user verification is enabled or not
- GEThttps://api.crisp.chat/v1/website/website_id/verify/settings
- Tiersuserwebsiteplugin
- Scopeswebsite:verify
(loading)
(loading)
Update Verify Settings
Updates verify settings.
The website identifier
Whether user verification is enabled or not
- PATCHhttps://api.crisp.chat/v1/website/website_id/verify/settings
- Tiersuserwebsiteplugin
- Scopeswebsite:verify
(loading)
(loading)
Get Verify Key
Resolves verify key. This key is to be used in the user backend to sign user data (eg. email) with an HMAC-SHA256 function.
The website identifier
Secret verify key (if any)
- GEThttps://api.crisp.chat/v1/website/website_id/verify/key
- Tiersuserwebsiteplugin
- Scopeswebsite:verify
(loading)
(loading)
Roll Verify Key
Rolls verify key. This requests a new keypair to be generated. Previous key will be invalidated.
The website identifier
- POSThttps://api.crisp.chat/v1/website/website_id/verify/key
- Tiersuserwebsiteplugin
- Scopeswebsite:verify
(loading)
(loading)
Auditin Website
Create Audit Log
Creates an audit-log entry for a website on behalf of the authenticated plugin. The target operator must be a member of the website. The entry is attributed to the plugin and its namespace is stored as an external namespace.
The website identifier
Audit action
Values
writedeleteread
Audit event namespace (lowercase segments separated by colons; maximum 40 characters)
Identifier of the website operator to associate with the audit entry
IPv4 or IPv6 address associated with the audit entry (the request IP is used when omitted)
Additional audit context (at most 10 lowercase alphanumeric or underscore keys, each up to 20 characters; values can be strings up to 100 characters, numbers, or booleans)
- POSThttps://api.crisp.chat/v1/website/website_id/audit/log
- Tiersplugin
(loading)
(loading)
Connectin Website
Get Website Connect Endpoints
Resolves the website endpoints information.
The website identifier
Socket endpoints
RTM API WebSocket endpoint URL
Stream API WebSocket endpoint URL
Rescue endpoints
Rescue socket endpoints
RTM API WebSocket rescue endpoint URL
Stream API WebSocket rescue endpoint URL
- GEThttps://api.crisp.chat/v1/website/website_id/connect/endpoints
- Tiersuserwebsite
(loading)
(loading)
Subscriptionin Plugin
Get Subscription Details
Resolves details on a given subscription.
The website identifier
The plugin identifier
Plugin identifier
Plugin Uniform Resource Name
Plugin type
Values
internalexternal
Plugin name
Plugin category
Values
featureautomationcmscrmmarketingmessagingteamworkother
Plugin summary
Plugin price (in platform-wide currency)
Plans the plugin is included in (if part of a plan)
Plan identifier
Plan name
Plan price (in platform-wide currency)
Plugin icon URL (if any)
Website for the plugin (if any)
Contact address for the plugin (if any)
Terms of use for the plugin (if any)
Privacy policy for the plugin (if any)
Help article for the plugin (if any)
Explanatory video for the plugin (if any)
Whether the plugin can be configured or not
Datetime since when the plugin is available
Whether the plugin is active, or has been disabled (eg: due to failed renewal payment)
Bill period (how often the subscription is paid for)
Values
monthlyyearly
Date until which the bill is valid for subscription (date at which the subscription will be renewed, thus paid again)
- GEThttps://api.crisp.chat/v1/plugins/subscription/website_id/plugin_id
- Tiersuserplugin
(loading)
(loading)
Get Subscription Settings
Resolves plugin subscription settings. Used to read plugin configuration on a given website.
The website identifier
The plugin identifier
Plugin identifier
Website identifier
Subscription secret token (used to authenticate against external configuration forms)
Configuration schema (JSONSchema)
Active configuration for subscription (format enforced by configuration schema)
URL to external configuration form page (if any)
URL to plugin authentication callback (if any)
- GEThttps://api.crisp.chat/v1/plugins/subscription/website_id/plugin_id/settings
- Tiersuserplugin
(loading)
(loading)
Save Subscription Settings
Saves plugin subscription settings (overwrites existing settings). Used to configure a given plugin on a given website.
Submit a raw JSON object containing the bare settings object. The object format is plugin-specific, and is enforced by the configuration schema.
The settings save acknowledgement is sent back asynchronously on the RTM Events channel, using the event namespace plugin:settings:saved.
The website identifier
The plugin identifier
- PUThttps://api.crisp.chat/v1/plugins/subscription/website_id/plugin_id/settings
- Tiersuserplugin
(loading)
(loading)
Update Subscription Settings
Updates plugin subscription settings (merges with existing settings). Used to configure a given plugin on a given website.
Submit a raw JSON object containing the bare settings object. The object format is plugin-specific, and is enforced by the configuration schema.
The settings save acknowledgement is sent back asynchronously on the RTM Events channel, using the event namespace plugin:settings:saved.
The website identifier
The plugin identifier
- PATCHhttps://api.crisp.chat/v1/plugins/subscription/website_id/plugin_id/settings
- Tiersuserplugin
(loading)
(loading)
Get Plugin Usage Bills
Acquires all non-settled (ie. open) usage bills for a subscribed plugin.
The website identifier
The plugin identifier
Name of the billable item
Total units consumed
Price to charge per unit
- GEThttps://api.crisp.chat/v1/plugins/subscription/website_id/plugin_id/bill/usage
- Tiersuserplugin
- Scopesplugin:subscription:bill
(loading)
(loading)
Report Plugin Usage To Bill
Reports a billable usage for a website using a subscribed plugin. This billable usage will be invoiced to the user whenever they get charged for other Crisp subscriptions.
The website identifier
The plugin identifier
Name of the billable item (eg. product name which will appear on user invoices)
Units consumed to add to the current bill (eg. 250 paid messages sent)
Price to charge per unit (eg. 0.10; only used when bill is created)
- POSThttps://api.crisp.chat/v1/plugins/subscription/website_id/plugin_id/bill/usage
- Tiersplugin
- Scopesplugin:subscription:bill
(loading)
(loading)
Get Plugin Attest Provenance
Attests for plugin user provenance, using the plugin signature secret. This provenance payload can be provided to the plugin eg. Web configuration UI, so that the plugin can independently authenticate the Crisp user and verify eg. their role in the website. This lets plugins implement some weak ACLs.
The website identifier
The plugin identifier
Attested payload (in JSON format)
Website origin
User origin (if request is from user tier)
User identifier
User role in website
Values
ownermember
Plugin origin (if request is from plugin tier)
Plugin identifier
JWT signed payload (using plugin signing secret)
Attestation signature expiration timestamp
- GEThttps://api.crisp.chat/v1/plugins/subscription/website_id/plugin_id/attest/provenance
- Tiersuserplugin
(loading)
(loading)
Forward Plugin Payload To Channel
Forwards generic payload given generic namespace to plugin channel.
The generic payload is sent back asynchronously on the RTM Events channel, using the event namespace plugin:channel.
The website identifier
The plugin identifier
Generic namespace to forward
Tracking identifier associated with payload (if any)
Generic payload to forward
- POSThttps://api.crisp.chat/v1/plugins/subscription/website_id/plugin_id/channel
- Tiersuserplugin
(loading)
(loading)
Dispatch Plugin Event
Dispatches a generic data event for plugin, for use with Web Hooks.
The generic data is sent back asynchronously on the RTM Events channel, using the event namespace plugin:event.
The website identifier
The plugin identifier
Generic name to dispatch
Generic data to dispatch
- POSThttps://api.crisp.chat/v1/plugins/subscription/website_id/plugin_id/event
- Tiersuserplugin
(loading)
(loading)
Connect Accountin Plugin
⭐ Get Connect Account
Resolves the current plugin account information.
Plugin identifier
- GEThttps://api.crisp.chat/v1/plugin/connect/account
- Tiersplugin
(loading)
(loading)
Connect Sessionin Plugin
⭐ Check Connect Session Validity
Checks whether the connected plugin session is valid or not.
- HEADhttps://api.crisp.chat/v1/plugin/connect/session
- Tiersplugin
(loading)
(loading)
Connect Websitesin Plugin
⭐ List All Connect Websites
Lists all websites linked to connected plugin.
The page number (paging if many websites)
Restrict to configured plugins only (1 or 0)
Whether to include the plan subscription in the listed websites (1 or 0, defaults to 0)
Website identifier
Plugin price (in platform-wide currency)
Subscription secret token (used to authenticate against external configuration forms)
Plugin settings for website
Plan that the website is subscribed to (if requested)
Plan identifier
Plan name
Whether the plan is trialing
- GEThttps://api.crisp.chat/v1/plugin/connect/websites/all/page_number
- Tiersplugin
(loading)
(loading)
List Connect Websites Since
Lists the websites linked or unlinked or updated for connected plugin, since given date. This is basically a differential that allows you to either add, remove or update websites in use for the plugin.
Date since when to proceed a differential response (ISO 8601)
Restrict to configured plugins only (1 or 0)
Whether to include the plan subscription in the listed websites (1 or 0, defaults to 0)
Website identifier
Plugin price (in platform-wide currency)
Subscription secret token (used to authenticate against external configuration forms)
Plugin settings for website
Plan that the website is subscribed to (if requested)
Plan identifier
Plan name
Whether the plan is trialing
Difference action (what to do with the differential data)
Values
addedupdatedremoved
- GEThttps://api.crisp.chat/v1/plugin/connect/websites/since
- Tiersplugin
(loading)
(loading)
Connect Endpointsin Plugin
⭐ Get Connect Endpoints
Resolves the current plugin endpoints information.
Socket endpoints
RTM API WebSocket endpoint URL
Rescue endpoints
Rescue socket endpoints
RTM API WebSocket rescue endpoint URL
- GEThttps://api.crisp.chat/v1/plugin/connect/endpoints
- Tiersplugin
(loading)
(loading)
Subscriptionin Plan
Get Plan Subscription For A Website
Resolves plan subscription for given website.
The website identifier
Plan identifier
Plan name
Plan price (in platform-wide currency)
Number of days the plan can be tried for free upon first subscription
Datetime since when the plan is available
Whether the plan is trialing
Date when the plan current trial ends (date after which the plan starts to be paid by the user)
Date when the plan trial ends, or ended (date after which the plan starts, or started, to be paid by the user)
Bill period (how often the subscription is paid for)
Values
monthlyyearly
Date until which the bill is valid for subscription (date at which the subscription will be renewed, thus paid again)
Whether the plan is active, or has been disabled (eg: due to failed renewal payment)
Whether the plan is in sandbox mode (sandbox mode is a restricted subscription mode used for development and staging websites)
Website identifier
Website name
Website domain
Website custom logo image URL (can be blank)
Whether a coupon was redeemed on this plan or not
Card identifier which is used to pay the plan subscription
Identity of the user responsible for the subscription (if any)
User identifier
User email
User first name
User last name
- GEThttps://api.crisp.chat/v1/plans/subscription/website_id
- Tiersuserwebsiteplugin
- Scopesplan:subscription
(loading)
(loading)
URLin Bucket
Generate Bucket URL
Generates a bucket URL. The URL is signed, and lets you upload a file directly to it.
The signed bucket URL response is sent back asynchronously on the RTM Events channel, using either the event namespace bucket:url:avatar:generated, bucket:url:upload:generated, bucket:url:website:generated, bucket:url:helpdesk:generated, bucket:url:status:generated, bucket:url:campaign:generated or bucket:url:processing:generated (depending on the request namespace parameter).
Bucket namespace
Values
avataruploadwebsitecampaignhelpdeskstatusprocessing
Tracking ID, returned in asynchronous callback
File name
File MIME type
File resource (ie. who owns the file)
Resource owner type
Values
websitesessionoperatorplugin
Resource owner identifier (for website, session, operator or plugin)
- POSThttps://api.crisp.chat/v1/bucket/url/generate
- Tiersuserwebsiteplugin
- Scopesbucket:url
(loading)
(loading)