The Crisp REST API offers access and control over all Crisp data (conversations, contacts and more).
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
- Tiersuserplugin
(loading)
(loading)
Create Website
Creates a new website.
Website name
Website domain
- POSThttps://api.crisp.chat/v1/website
- Tiersuser
(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)
- GEThttps://api.crisp.chat/v1/website/website_id
- Tiersuserplugin
(loading)
(loading)
Delete A Website
Deletes an existing website.
The website identifier
User identity verification challenge (used to double-authenticate deletion)
Verification method (whichever is more secure for the user account)
Values
passwordtokengoogle
Secret value (for method)
- DELETEhttps://api.crisp.chat/v1/website/website_id
- Tiersuser
(loading)
(loading)
Abort Website Deletion
Aborts scheduled deletion for an existing website.
The website identifier
- DELETEhttps://api.crisp.chat/v1/website/website_id/expunge
- Tiersuser
(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
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 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
12
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)
External participants for this conversation
External participant type
Values
email
External participant target (ie. email address, identifier, etc.)
Mentioned user identifiers (from conversation messages)
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)
Visitor IP address
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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- Scopeswebsite:conversation:suggest
(loading)
(loading)
List Spam Conversations
Lists spam conversations in website. Those are not conversation entities, but can be converted to conversations if a spam is later accepted as ham.
The website identifier
The page number (paging in spam list)
Filter by spam type (eg. email)
Spam identifier
Spam type
Values
email
Reason for spam classification (if any)
Arbitrary metadata from message original
Headers from message original (ie. if email)
Timestamp of spam (when the spam was inserted)
- GEThttps://api.crisp.chat/v1/website/website_id/conversations/spams/page_number
- Tiersuser
(loading)
(loading)
Resolve Spam Conversation Content
Resolves full content for spam conversation.
The website identifier
The spam identifier
Spam identifier
Spam type
Values
email
Reason for spam classification (if any)
Arbitrary metadata from message original
Headers from message original (ie. if email)
Spam content
Timestamp of spam (when the spam was inserted)
- GEThttps://api.crisp.chat/v1/website/website_id/conversations/spam/spam_id/content
- Tiersuser
(loading)
(loading)
Submit Spam Conversation Decision
Submits decision on spam conversation (this allows to accepts or rejects a spam). If rejected, a spam message will be gone forever. If accepted, it will get transformed into a regular conversation.
The decision acknowledgement is sent back asynchronously on the RTM Events channel, using the event namespace spam:decision.
The website identifier
The spam identifier
Action to take on spam
Values
acceptreject
- POSThttps://api.crisp.chat/v1/website/website_id/conversations/spam/spam_id/decision
- Tiersuser
(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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
12
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 identifiers (from conversation messages)
External participants for this conversation
External participant type
Values
email
External participant target (ie. email address, identifier, etc.)
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)
Visitor IP address
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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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 up to most recent message using the timestamp_before parameter.
The website identifier
The conversation session identifier
Returned message batch should end before given timestamp (used for infinite scroll paging)
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 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:*
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
- GEThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/messages
- Tiersuserplugin
- 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 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/html
Original message data content
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
- Tiersuserplugin
- 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 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:*
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
- GEThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/message/fingerprint
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
(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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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)
Visitor IP address
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
- Tiersuserplugin
- 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)
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
- Tiersuserplugin
- 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/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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- PATCHhttps://api.crisp.chat/v1/website/website_id/conversation/session_id/state
- Tiersuserplugin
- Scopeswebsite:conversation:states
(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
- Tiersuserplugin
- 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.)
- PUThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/participants
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- PATCHhttps://api.crisp.chat/v1/website/website_id/conversation/session_id/block
- Tiersuserplugin
- Scopeswebsite:conversation:actions
(loading)
(loading)
Get Verify Status For Conversation
Resolves conversation verify status.
The website identifier
The conversation session identifier
Verify status
- GEThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/verify
- Tiersuserplugin
- 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
- Tiersuserplugin
- Scopeswebsite:conversation:actions
(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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- POSThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/call
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- DELETEhttps://api.crisp.chat/v1/website/website_id/conversation/session_id/call/call_id
- Tiersuserplugin
- 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
- Tiersuserplugin
- Scopeswebsite:conversation:calls
(loading)
(loading)
Deliver Widget Button Action For Conversation
Delivers a button action on plugin widget for conversation, used to perform an action on the plugin, eg. refund a user. A hook will be sent to the plugin widget receiver.
Delivery completion or failure will be acknowledged on the RTM Events channel, using the event namespace widget:action:processed.
The website identifier
The conversation session identifier
The plugin identifier for widget
Widget section identifier
Widget item identifier
Data to be sent along the button hook (can be empty)
Value to be sent along the button hook (if any)
- POSThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/widget/plugin_id/button
- Tiersuser
(loading)
(loading)
Deliver Widget Data Action For Conversation
Delivers a data action on plugin widget for conversation, used to either fetch or edit a data value from the plugin, eg. fetch a user unpaid balance. A hook will be sent to the plugin widget receiver.
Delivery completion will be acknowledged on the RTM Events channel, using the event namespace widget:action:processed.
The website identifier
The conversation session identifier
The plugin identifier for widget
Widget section identifier
Widget item identifier
Action to take on data
Values
fetchedit
Payload data (if action is fetch)
Replacement value for data (if action is edit)
- POSThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/widget/plugin_id/data
- Tiersuser
(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
- POSThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/reminder
- Tiersuserplugin
- Scopeswebsite:conversation:reminders
(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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- Scopeswebsite:people:conversations
(loading)
(loading)
List People Campaigns
Lists campaigns linked to people.
The website identifier
The people identifier (also allowed: people email)
The page number (paging in campaign list)
Campaign identifier
Campaign type
Values
one-shotautomated
Campaign name
Campaign creation timestamp
Campaign update timestamp
Campaign dispatch timestamp
Statistic occurred timestamp
Statistic points on campaign (ie. actions the user took on campaign)
Values
campaign:openedcampaign:clickedcampaign:unsubscribed
- GEThttps://api.crisp.chat/v1/website/website_id/people/campaigns/people_id/list/page_number
- Tiersuser
(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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- Scopeswebsite:people:subscriptions
(loading)
(loading)
Export People Profiles
Exports people profiles. The exported data is sent back to email to the requester user.
The website identifier
- POSThttps://api.crisp.chat/v1/website/website_id/people/export/profiles
- Tiersuser
(loading)
(loading)
Import People Profiles
Imports people profiles. The imported data, eg. a CSV file containing user emails and full names is used to populate website user database.
The import events are sent back asynchronously on the RTM Events channel, using either the event namespace people:import:progress or people:import:done.
The website identifier
File URL containing user data to be imported
Raw data to Crisp data mapping
Mapping from raw data column index (starts at 1)
Mapping to Crisp field (regular field, or virtual field starting with _.)
Values
emailsegmentsnotepadperson.nicknameperson.phoneperson.addressperson.websiteperson.geolocation.countryperson.geolocation.citycompany.namedata.[*]created_atactive_.person.first_name_.person.last_name_.unsubscribed
Import options
One-character column separator
Whether to skip headers or not
- POSThttps://api.crisp.chat/v1/website/website_id/people/import/profiles
- Tiersuser
(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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- Scopeswebsite:visitors
(loading)
(loading)
Count Blocked Visitors
Counts all blocked visitors on website, by rule list.
The website identifier
Rule name
Values
ipemail
Number of blocked visitors for rule
- GEThttps://api.crisp.chat/v1/website/website_id/visitors/blocked
- Tiersuser
(loading)
(loading)
Count Blocked Visitors In Rule
Counts all blocked visitors in rule list on website.
The website identifier
The block rule (ip or email)
Rule name
Values
ipemail
Number of blocked visitors for rule
- GEThttps://api.crisp.chat/v1/website/website_id/visitors/blocked/block_rule
- Tiersuser
(loading)
(loading)
Clear Blocked Visitors In Rule
Clears all blocked visitors in rule list on website.
The website identifier
The block rule (ip or email)
- DELETEhttps://api.crisp.chat/v1/website/website_id/visitors/blocked/block_rule
- Tiersuser
(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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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)
User invite key (for invite type only)
- GEThttps://api.crisp.chat/v1/website/website_id/operators/list
- Tiersuserplugin
- 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
- Tiersuserplugin
- Scopeswebsite:operators
(loading)
(loading)
Flush Last Active Website Operators
Flushes the list of last active website operators, ie. operators who last replied to a visitor message.
The website identifier
- DELETEhttps://api.crisp.chat/v1/website/website_id/operators/active
- Tiersuser
(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
- PATCHhttps://api.crisp.chat/v1/website/website_id/operators/email
- Tiersuserplugin
- 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
- Tiersuserplugin
- Scopeswebsite:operators
(loading)
(loading)
Invite A Website Operator
Invites an email to join website as operator. The target email doesn't need to be a valid Crisp account, since Crisp will send an invite email to that email. The receiver is then prompted to click on a link to either join the website with an existing account, or create a new account on the fly.
The website identifier
Operator email
Operator role
Values
ownermember
User identity verification challenge (used to double-authenticate invite)
Verification method (whichever is more secure for the user account)
Values
passwordtokengoogle
Secret value (for method)
- POSThttps://api.crisp.chat/v1/website/website_id/operator
- Tiersuser
(loading)
(loading)
Change Operator Membership
Changes the membership of an existing operator. Useful to downgrade or upgrade an operator from/to owner role, or change their title in the team.
The website identifier
The user identifier for operator
Operator role
Values
ownermember
Operator title (if any)
- PATCHhttps://api.crisp.chat/v1/website/website_id/operator/user_id
- Tiersuser
(loading)
(loading)
Unlink Operator From Website
Unlinks given operator from website. Note that the last operator in the website cannot be unlinked.
The website identifier
The user identifier for operator
- DELETEhttps://api.crisp.chat/v1/website/website_id/operator/user_id
- Tiersuser
(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
- Tiersuserplugin
- 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
- Tiersuserplugin
- Scopeswebsite:helpdesk:identity
(loading)
(loading)
Initialize Helpdesk
Initializes a new helpdesk for website.
The website identifier
Name of the helpdesk
Basic domain of the helpdesk (subdomain of default root domain)
- POSThttps://api.crisp.chat/v1/website/website_id/helpdesk
- Tiersuser
(loading)
(loading)
Delete Helpdesk
Deletes helpdesk for website.
The website identifier
User identity verification challenge (used to double-authenticate deletion)
Verification method (whichever is more secure for the user account)
Values
passwordtokengoogle
Secret value (for method)
- DELETEhttps://api.crisp.chat/v1/website/website_id/helpdesk
- Tiersuser
(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
Number of articles for locale
Number of categories for locale
- GEThttps://api.crisp.chat/v1/website/website_id/helpdesk/locales/page_number
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
Number of articles for locale
Number of categories for locale
- GEThttps://api.crisp.chat/v1/website/website_id/helpdesk/locale/locale
- Tiersuserplugin
- 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
- Tiersuserplugin
- Scopeswebsite:helpdesk:locales
(loading)
(loading)
List Helpdesk Locale Articles
Lists articles for a helpdesk locale in website.
The website identifier
The locale code
Page number for articles paging
Whether to order articles by visits instead of default order (1 or 0)
Search by article title
Filter by article category identifier (identifier or none)
Filter by article section identifier (identifier or none, requires filter_category_id to be set as well)
Filter by article published status (1 or 0)
Filter by article draft status (1 or 0)
Filter by article visible visibility (1 or 0)
Filter by article hidden visibility (1 or 0)
When to start relative to article creation date (date, ISO 8601)
When to end relative to article creation date (date, ISO 8601)
Article identifier
Title of the article
Status of the article
Values
publisheddraft
Visibility of the article (if status is published)
Values
visiblehidden
Whether the article is featured or not
Number of times the article has been visited
Article ordering weight
Public URL of the article (if status is published)
Category of the article (if any)
Category identifier
Name of the category
Color of the category (hexadecimal color code, if any)
Section within the category (if any)
Section identifier
Name of the section
Article creation timestamp
Article update timestamp
Article publication timestamp
- GEThttps://api.crisp.chat/v1/website/website_id/helpdesk/locale/locale/articles/page_number
- Tiersuserplugin
- Scopeswebsite:helpdesk:articles
(loading)
(loading)
Add A New Helpdesk Locale Article
Adds a new locale article for helpdesk in website.
The website identifier
The locale code
Title of the article
- POSThttps://api.crisp.chat/v1/website/website_id/helpdesk/locale/locale/article
- Tiersuserplugin
- Scopeswebsite:helpdesk:articles
(loading)
(loading)
Check If Helpdesk Locale Article Exists
Checks if a locale article exists for helpdesk in website.
The website identifier
The locale code
The article identifier
- HEADhttps://api.crisp.chat/v1/website/website_id/helpdesk/locale/locale/article/article_id
- Tiersuserplugin
- Scopeswebsite:helpdesk:articles
(loading)
(loading)
Resolve Helpdesk Locale Article
Resolves a locale article for helpdesk in website.
The website identifier
The locale code
The article identifier
Article identifier
Title of the article
Description of the article (if any)
Text content of the article
Status of the article
Values
publisheddraft
Visibility of the article (if status is published)
Values
visiblehidden
Whether the article is featured or not
Number of times the article has been visited
Article ordering weight
Public URL of the article (if status is published)
Article creation timestamp
Article update timestamp
Article publication timestamp
- GEThttps://api.crisp.chat/v1/website/website_id/helpdesk/locale/locale/article/article_id
- Tiersuserplugin
- Scopeswebsite:helpdesk:articles
(loading)
(loading)
Save Helpdesk Locale Article
Saves a locale article for helpdesk in website.
The website identifier
The locale code
The article identifier
Title of the article
Description of the article (if any)
Text content of the article
Whether the article is featured or not
Article ordering weight
- PUThttps://api.crisp.chat/v1/website/website_id/helpdesk/locale/locale/article/article_id
- Tiersuserplugin
- Scopeswebsite:helpdesk:articles
(loading)
(loading)
Update Helpdesk Locale Article
Updates a locale article for helpdesk in website.
The website identifier
The locale code
The article identifier
Title of the article
Description of the article (if any)
Text content of the article
Whether the article is featured or not
Article ordering weight
- PATCHhttps://api.crisp.chat/v1/website/website_id/helpdesk/locale/locale/article/article_id
- Tiersuserplugin
- Scopeswebsite:helpdesk:articles
(loading)
(loading)
Delete Helpdesk Locale Article
Deletes a locale article for helpdesk in website.
The website identifier
The locale code
The article identifier
- DELETEhttps://api.crisp.chat/v1/website/website_id/helpdesk/locale/locale/article/article_id
- Tiersuserplugin
- Scopeswebsite:helpdesk:articles
(loading)
(loading)
Resolve Helpdesk Locale Article Page
Resolves a locale article page information for helpdesk in website.
The website identifier
The locale code
The article identifier
Title of the article
Public URL of the article (if article status is published)
- GEThttps://api.crisp.chat/v1/website/website_id/helpdesk/locale/locale/article/article_id/page
- Tiersuserplugin
- Scopeswebsite:helpdesk:articles
(loading)
(loading)
Resolve Helpdesk Locale Article Category
Resolves a locale article category for helpdesk in website.
The website identifier
The locale code
The article identifier
Category identifier (if any)
Section identifier (if any)
- GEThttps://api.crisp.chat/v1/website/website_id/helpdesk/locale/locale/article/article_id/category
- Tiersuserplugin
- Scopeswebsite:helpdesk:articles
(loading)
(loading)
Update Helpdesk Locale Article Category
Updates a locale article category for helpdesk in website.
The website identifier
The locale code
The article identifier
Category identifier (can be blank)
Section identifier (can be blank)
- PATCHhttps://api.crisp.chat/v1/website/website_id/helpdesk/locale/locale/article/article_id/category
- Tiersuserplugin
- Scopeswebsite:helpdesk:articles
(loading)
(loading)
List Helpdesk Locale Article Alternates
Lists alternate locales on a locale article for helpdesk in website.
The website identifier
The locale code
The article identifier
Locale code for alternate
Article identifier for alternate
- GEThttps://api.crisp.chat/v1/website/website_id/helpdesk/locale/locale/article/article_id/alternates
- Tiersuserplugin
- Scopeswebsite:helpdesk:articles
(loading)
(loading)
Check If Helpdesk Locale Article Alternate Exists
Checks if alternate locale exists on a locale article for helpdesk in website.
The website identifier
The locale code
The article identifier
The linked locale code
- HEADhttps://api.crisp.chat/v1/website/website_id/helpdesk/locale/locale/article/article_id/alternate/locale_linked
- Tiersuserplugin
- Scopeswebsite:helpdesk:articles
(loading)
(loading)
Resolve Helpdesk Locale Article Alternate
Resolves alternate locale on a locale article for helpdesk in website.
The website identifier
The locale code
The article identifier
The linked locale code
Locale code for alternate
Article identifier for alternate
- GEThttps://api.crisp.chat/v1/website/website_id/helpdesk/locale/locale/article/article_id/alternate/locale_linked
- Tiersuserplugin
- Scopeswebsite:helpdesk:articles
(loading)
(loading)
Save Helpdesk Locale Article Alternate
Saves alternate locale on a locale article for helpdesk in website.
The website identifier
The locale code
The article identifier
The linked locale code
Article identifier to be linked for locale
- PUThttps://api.crisp.chat/v1/website/website_id/helpdesk/locale/locale/article/article_id/alternate/locale_linked
- Tiersuserplugin
- Scopeswebsite:helpdesk:articles
(loading)
(loading)
Delete Helpdesk Locale Article Alternate
Deletes alternate locale on a locale article for helpdesk in website.
The website identifier
The locale code
The article identifier
The linked locale code
- DELETEhttps://api.crisp.chat/v1/website/website_id/helpdesk/locale/locale/article/article_id/alternate/locale_linked
- Tiersuserplugin
- Scopeswebsite:helpdesk:articles
(loading)
(loading)
Publish Helpdesk Locale Article
Publishes a locale article for helpdesk in website.
The website identifier
The locale code
The article identifier
- POSThttps://api.crisp.chat/v1/website/website_id/helpdesk/locale/locale/article/article_id/publish
- Tiersuserplugin
- Scopeswebsite:helpdesk:articles
(loading)
(loading)
Unpublish Helpdesk Locale Article
Unpublishes a locale article for helpdesk in website.
The website identifier
The locale code
The article identifier
- POSThttps://api.crisp.chat/v1/website/website_id/helpdesk/locale/locale/article/article_id/unpublish
- Tiersuserplugin
- Scopeswebsite:helpdesk:articles
(loading)
(loading)
List Helpdesk Locale Categories
Lists locale categories for helpdesk in website.
The website identifier
The locale code
Page number for categories paging
Search by category name
Category identifier
Name of the category
Description of the category (if any)
Color of the category (hexadecimal color code, if any)
Image URL of the category (if any)
Category ordering weight
Public URL of the category
Number of articles in the category
Number of sections in the category
Category creation timestamp
Category update timestamp
- GEThttps://api.crisp.chat/v1/website/website_id/helpdesk/locale/locale/categories/page_number
- Tiersuserplugin
- Scopeswebsite:helpdesk:categories
(loading)
(loading)
Add Helpdesk Locale Category
Adds a locale category for helpdesk in website.
The website identifier
The locale code
Name of the category to add
- POSThttps://api.crisp.chat/v1/website/website_id/helpdesk/locale/locale/category
- Tiersuserplugin
- Scopeswebsite:helpdesk:categories
(loading)
(loading)
Check If Helpdesk Locale Category Exists
Checks if a locale category exists for helpdesk in website.
The website identifier
The locale code
The category identifier
- HEADhttps://api.crisp.chat/v1/website/website_id/helpdesk/locale/locale/category/category_id
- Tiersuserplugin
- Scopeswebsite:helpdesk:categories
(loading)
(loading)
Resolve Helpdesk Locale Category
Resolves a locale category for helpdesk in website.
The website identifier
The locale code
The category identifier
Category identifier
Name of the category
Description of the category (if any)
Color of the category (hexadecimal color code, if any)
Image URL of the category (if any)
Category ordering weight
Public URL of the category
Number of articles in the category
Number of sections in the category
Category creation timestamp
Category update timestamp
- GEThttps://api.crisp.chat/v1/website/website_id/helpdesk/locale/locale/category/category_id
- Tiersuserplugin
- Scopeswebsite:helpdesk:categories
(loading)
(loading)
Save Helpdesk Locale Category
Saves a locale category for helpdesk in website.
The website identifier
The locale code
The category identifier
Name of the category
Description of the category (can be blank)
Color of the category (hexadecimal color code, can be blank)
Image URL of the category (can be blank)
Category ordering weight
- PUThttps://api.crisp.chat/v1/website/website_id/helpdesk/locale/locale/category/category_id
- Tiersuserplugin
- Scopeswebsite:helpdesk:categories
(loading)
(loading)
Update Helpdesk Locale Category
Updates a locale category for helpdesk in website.
The website identifier
The locale code
The category identifier
Name of the category
Description of the category (can be blank)
Color of the category (hexadecimal color code, can be blank)
Image URL of the category (can be blank)
Category ordering weight
- PATCHhttps://api.crisp.chat/v1/website/website_id/helpdesk/locale/locale/category/category_id
- Tiersuserplugin
- Scopeswebsite:helpdesk:categories
(loading)
(loading)
Delete Helpdesk Locale Category
Deletes a locale category for helpdesk in website.
The website identifier
The locale code
The category identifier
- DELETEhttps://api.crisp.chat/v1/website/website_id/helpdesk/locale/locale/category/category_id
- Tiersuserplugin
- Scopeswebsite:helpdesk:categories
(loading)
(loading)
List Helpdesk Locale Sections
Lists locale sections for helpdesk in website and category.
The website identifier
The locale code
The category identifier
Page number for sections paging
Search by section name
Section identifier
Name of the section
Section ordering weight
Section creation timestamp
Section update timestamp
- GEThttps://api.crisp.chat/v1/website/website_id/helpdesk/locale/locale/category/category_id/sections/page_number
- Tiersuserplugin
- Scopeswebsite:helpdesk:categories
(loading)
(loading)
Add Helpdesk Locale Section
Adds a locale section for helpdesk in website and category.
The website identifier
The locale code
The category identifier
Name of the section to add
- POSThttps://api.crisp.chat/v1/website/website_id/helpdesk/locale/locale/category/category_id/section
- Tiersuserplugin
- Scopeswebsite:helpdesk:categories
(loading)
(loading)
Check If Helpdesk Locale Section Exists
Checks if a locale section exists for helpdesk in website and category.
The website identifier
The locale code
The category identifier
The section identifier
- HEADhttps://api.crisp.chat/v1/website/website_id/helpdesk/locale/locale/category/category_id/section/section_id
- Tiersuserplugin
- Scopeswebsite:helpdesk:categories
(loading)
(loading)
Resolve Helpdesk Locale Section
Resolves a locale section for helpdesk in website and category.
The website identifier
The locale code
The category identifier
The section identifier
Section identifier
Name of the section
Section ordering weight
Section creation timestamp
Section update timestamp
- GEThttps://api.crisp.chat/v1/website/website_id/helpdesk/locale/locale/category/category_id/section/section_id
- Tiersuserplugin
- Scopeswebsite:helpdesk:categories
(loading)
(loading)
Save Helpdesk Locale Section
Saves a locale section for helpdesk in website and category.
The website identifier
The locale code
The category identifier
The section identifier
Name of the section
Section ordering weight
- PUThttps://api.crisp.chat/v1/website/website_id/helpdesk/locale/locale/category/category_id/section/section_id
- Tiersuserplugin
- Scopeswebsite:helpdesk:categories
(loading)
(loading)
Update Helpdesk Locale Section
Updates a locale section for helpdesk in website and category.
The website identifier
The locale code
The category identifier
The section identifier
Name of the section
Section ordering weight
- PATCHhttps://api.crisp.chat/v1/website/website_id/helpdesk/locale/locale/category/category_id/section/section_id
- Tiersuserplugin
- Scopeswebsite:helpdesk:categories
(loading)
(loading)
Delete Helpdesk Locale Section
Deletes a locale section for helpdesk in website and category.
The website identifier
The locale code
The category identifier
The section identifier
- DELETEhttps://api.crisp.chat/v1/website/website_id/helpdesk/locale/locale/category/category_id/section/section_id
- Tiersuserplugin
- Scopeswebsite:helpdesk:categories
(loading)
(loading)
Map Helpdesk Locale Feedback Ratings
Map locale feedback ratings for helpdesk in website.
The website identifier
The locale code
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/locale/locale/feedback/ratings
- Tiersuserplugin
- Scopeswebsite:helpdesk:feedbacks
(loading)
(loading)
List Helpdesk Locale Feedbacks
Lists locale feedbacks for helpdesk in website.
The website identifier
The locale code
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/locale/locale/feedback/list/page_number
- Tiersuserplugin
- Scopeswebsite:helpdesk:feedbacks
(loading)
(loading)
Import External Helpdesk To Locale
Imports a whole external helpdesk to Crisp, as a Crisp Helpdesk. The import crawler pipeline is asynchronous.
The website identifier
The locale code
URL of the external helpdesk to import
- POSThttps://api.crisp.chat/v1/website/website_id/helpdesk/locale/locale/import
- Tiersuser
(loading)
(loading)
Export Helpdesk Locale Articles
Exports helpdesk articles for locale. The exported data is sent back to email to the requester user.
The website identifier
The locale code
- POSThttps://api.crisp.chat/v1/website/website_id/helpdesk/locale/locale/export
- Tiersuser
(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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
Logos of the helpdesk
Header logo URL (if any)
Footer logo URL (if any)
Banner image URL (if any)
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 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)
Include configuration for the helpdesk
Raw HTML include (if any)
Access restrictions for the helpdesk
Password requested to access the helpdesk (if any)
- GEThttps://api.crisp.chat/v1/website/website_id/helpdesk/settings
- Tiersuserplugin
- 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
Logos of the helpdesk
Header logo URL (can be blank)
Footer logo URL (can be blank)
Banner image URL (can be blank)
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 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)
Include configuration for the helpdesk
Raw HTML include (if any)
Access restrictions for the helpdesk
Password requested to access the helpdesk (if any)
- PATCHhttps://api.crisp.chat/v1/website/website_id/helpdesk/settings
- Tiersuserplugin
- Scopeswebsite:helpdesk:settings
(loading)
(loading)
Resolve Helpdesk Domain
Resolves domain for helpdesk in website.
The website identifier
Root domain for all helpdesks
Basic domain (subdomain of provided root domain)
Custom domain (fully qualified domain, if any)
Whether in-use domain could lastly be verified or not (domain is re-validated periodically)
- GEThttps://api.crisp.chat/v1/website/website_id/helpdesk/domain
- Tiersuser
(loading)
(loading)
Request Helpdesk Domain Change
Requests a change in the domain used for helpdesk. The change will be propagated once all setup steps are fulfilled (see the setup route).
The domain validation result is sent back asynchronously on the RTM Events channel, using either event namespace website:validate:domain:valid or website:validate:domain:invalid (if the custom domain was changed and thus requires validation).
The website identifier
Basic domain (subdomain of crisp.help)
Custom domain (fully qualified domain, can be blank)
- PATCHhttps://api.crisp.chat/v1/website/website_id/helpdesk/domain
- Tiersuser
(loading)
(loading)
Generate Helpdesk Domain Setup Flow
Retrieves the domain setup flow for helpdesk. This will return the DNS records required for helpdesk domain setup.
The website identifier
Custom domain to use for setup
Custom helpdesk domain to return setup for
Setup flow for custom helpdesk domain
DNS records for custom helpdesk domain
DNS record type
Values
aaaaacnamemxtxtsrv
DNS query type (ie. record valid for query type)
Values
aaaaacnamemxtxtsrv
DNS record name
DNS record value
- GEThttps://api.crisp.chat/v1/website/website_id/helpdesk/domain/setup
- Tiersuser
(loading)
(loading)
Campaignsin Website
List Campaigns
Lists campaigns for website.
The website identifier
Page number for campaigns paging
Search by campaign name
Filter by campaign tag
Filter by campaign one-shot type (1 or 0)
Filter by campaign automated type (1 or 0)
Filter by campaign not configured status (1 or 0)
Filter by campaign ready status (1 or 0)
Filter by campaign paused status (1 or 0)
Filter by campaign sending status (1 or 0)
Filter by campaign done status (1 or 0)
Campaign identifier
Campaign type
Values
one-shotautomated
Campaign format
Values
markdownhtml
Campaign name
Campaign subject
Campaign tag (if any)
Campaign ready state
Campaign dispatched state
Campaign running state
Campaign progress percentage (from 0 to 100)
Number of targets (number of users the campaign reaches)
Number of reached users (number of users who received the campaign message)
Campaign creation timestamp
Campaign update timestamp
Campaign dispatch timestamp
- GEThttps://api.crisp.chat/v1/website/website_id/campaigns/list/page_number
- Tiersuser
(loading)
(loading)
List Campaign Tags
Lists campaign tags for website.
The website identifier
Campaign tags
- GEThttps://api.crisp.chat/v1/website/website_id/campaigns/tags
- Tiersuser
(loading)
(loading)
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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- Scopeswebsite:campaign:templates
(loading)
(loading)
Campaignin Website
Create A New Campaign
Creates a new campaign.
The website identifier
Campaign type
Values
one-shotautomated
Campaign name
- POSThttps://api.crisp.chat/v1/website/website_id/campaign
- Tiersuser
(loading)
(loading)
Check If Campaign Exists
Checks if given campaign exists.
The website identifier
The campaign identifier
- HEADhttps://api.crisp.chat/v1/website/website_id/campaign/campaign_id
- Tiersuser
(loading)
(loading)
Get A Campaign
Resolves campaign information.
The website identifier
The campaign identifier
Campaign identifier
Campaign type
Values
one-shotautomated
Campaign format
Values
markdownhtml
Campaign name
Campaign subject
Campaign tag (if any)
Campaign sender
Sender user identifier (member of website)
Campaign recipients (if type is one-shot)
Recipient routing type
Values
allsegmentpeoplefilter
Routing segments (if type is segment)
Routing people (if type is people)
Routing filter (if type is filter)
Filter model
Values
people
Filter criterion (in model)
Filter operator
Values
eqneqexnexhasnhasswewgteltegtlt
Filter query terms
Campaign flow (if type is automated)
Event identifier that triggers automation flow (to run campaign for a user)
Filter to assert when event is triggered (can be empty)
Filter model
Values
people
Filter criterion (in model)
Filter operator
Values
eqneqexnexhasnhasswewgteltegtlt
Filter query terms
Delay in minutes after which to process assertions (no delay by default)
Ensures campaign is delivered once at a maximum for a given user, or not
Delivery delay in minutes (no delay by default)
Campaign message
Campaign options
Whether to deliver message to chatbox or not
Whether to deliver message to email or not
Whether to append website name after email sender name or not
Email address to use as a reply-to address for email campaigns
Whether to enable tracking or not
Campaign statistics
Number of recipients who opened the campaign email
Number of recipients who clicked on a link in the campaign email
Number of recipients who unsubscribed from the campaign email
Campaign ready state
Campaign dispatched state
Campaign running state
Campaign progress percentage (from 0 to 100)
Number of targets (number of users the campaign reaches)
Number of reached users (number of users who received the campaign message)
Campaign creation timestamp
Campaign update timestamp
Campaign dispatch timestamp
- GEThttps://api.crisp.chat/v1/website/website_id/campaign/campaign_id
- Tiersuser
(loading)
(loading)
Save A Campaign
Saves a campaign in website, and overwrite previous campaign information.
The website identifier
The campaign identifier
Campaign type
Values
one-shotautomated
Campaign format
Values
markdownhtml
Campaign name
Campaign subject
Campaign tag (can be empty)
Campaign sender
Sender user identifier (member of website)
Campaign recipients (if type is one-shot)
Recipient routing type
Values
allsegmentpeoplefilter
Routing segments (if type is segment)
Routing people (if type is people)
Routing filter (if type is filter)
Filter model
Values
people
Filter criterion (in model)
Filter operator
Values
eqneqexnexhasnhasswewgteltegtlt
Filter query terms
Campaign flow (if type is automated)
Event identifier that triggers automation flow (to run campaign for a user)
Filter to assert when event is triggered (can be empty)
Filter model
Values
people
Filter criterion (in model)
Filter operator
Values
eqneqexnexhasnhasswewgteltegtlt
Filter query terms
Delay in minutes after which to process assertions (no delay by default)
Ensures campaign is delivered once at a maximum for a given user, or not
Delivery delay in minutes (no delay by default)
Campaign message
Campaign options
Whether to deliver message to chatbox or not
Whether to deliver message to email or not
Whether to append website name after email sender name or not
Email address to use as a reply-to address for email campaigns
Whether to enable tracking or not
- PUThttps://api.crisp.chat/v1/website/website_id/campaign/campaign_id
- Tiersuser
(loading)
(loading)
Update A Campaign
Updates a campaign in website, and save only changed fields.
The website identifier
The campaign identifier
Campaign type
Values
one-shotautomated
Campaign format
Values
markdownhtml
Campaign name
Campaign subject
Campaign tag (can be empty)
Campaign sender
Sender user identifier (member of website)
Campaign recipients (if type is one-shot)
Recipient routing type
Values
allsegmentpeoplefilter
Routing segments (if type is segment)
Routing people (if type is people)
Routing filter (if type is filter)
Filter model
Values
people
Filter criterion (in model)
Filter operator
Values
eqneqexnexhasnhasswewgteltegtlt
Filter query terms
Campaign flow (if type is automated)
Event identifier that triggers automation flow (to run campaign for a user)
Filter to assert when event is triggered (can be empty)
Filter model
Values
people
Filter criterion (in model)
Filter operator
Values
eqneqexnexhasnhasswewgteltegtlt
Filter query terms
Delay in minutes after which to process assertions (no delay by default)
Ensures campaign is delivered once at a maximum for a given user, or not
Delivery delay in minutes (no delay by default)
Campaign message
Campaign options
Whether to deliver message to chatbox or not
Whether to deliver message to email or not
Whether to append website name after email sender name or not
Email address to use as a reply-to address for email campaigns
Whether to enable tracking or not
- PATCHhttps://api.crisp.chat/v1/website/website_id/campaign/campaign_id
- Tiersuser
(loading)
(loading)
Remove A Campaign
Removes a campaign in website.
The website identifier
The campaign identifier
- DELETEhttps://api.crisp.chat/v1/website/website_id/campaign/campaign_id
- Tiersuser
(loading)
(loading)
Dispatch A Campaign
Dispatches a ready campaign.
The website identifier
The campaign identifier
- POSThttps://api.crisp.chat/v1/website/website_id/campaign/campaign_id/dispatch
- Tiersuser
(loading)
(loading)
Resume A Campaign
Resumes a paused and dispatched campaign.
The website identifier
The campaign identifier
- POSThttps://api.crisp.chat/v1/website/website_id/campaign/campaign_id/resume
- Tiersuser
(loading)
(loading)
Pause A Campaign
Pauses a running and dispatched campaign.
The website identifier
The campaign identifier
- POSThttps://api.crisp.chat/v1/website/website_id/campaign/campaign_id/pause
- Tiersuser
(loading)
(loading)
Test A Campaign
Tests a ready campaign.
The website identifier
The campaign identifier
- POSThttps://api.crisp.chat/v1/website/website_id/campaign/campaign_id/test
- Tiersuser
(loading)
(loading)
List Campaign Recipients
Lists campaigns recipients on a non-dispatched one-shot campaign for website. This can be used to preview the recipients the campaign will get delivered to.
The website identifier
The campaign identifier
Page number for recipients paging
People identifier
Email for people profile
Personal information
Nickname for user (includes first name and last name)
Avatar for user
Whether profile is subscribed to emails or not
- GEThttps://api.crisp.chat/v1/website/website_id/campaign/campaign_id/recipients/page_number
- Tiersuser
(loading)
(loading)
List Campaign Statistics
Lists campaigns statistics on action for website. This can be used to see who opened a sent campaign, clicked on a link or unsubscribed from the campaign.
The website identifier
The campaign identifier
The statistics action (either clicked, opened or unsubscribed)
Page number for statistics paging
Profile associated to statistics point
People identifier
Email for people profile
Personal information
Nickname for user (includes first name and last name)
Avatar for user
Geolocation information for user
Country code
Region code
City name
Location coordinates
Latitude coordinate
Longitude coordinate
Generic data associated to statistics (format depends on requested action)
Statistics create timestamp
Statistics update timestamp
- GEThttps://api.crisp.chat/v1/website/website_id/campaign/campaign_id/statistics/action/page_number
- Tiersuser
(loading)
(loading)
Analyticsin Website
Generate Analytics
Generates analytics for given type and metric in website.
The website identifier
Analytics metric
Values
conversationconversation_assignedconversation_shortcutconversation_segmenthelpdesk_readhelpdesk_searchvisitor_visitvisitor_triggercampaign_activitycampaign_sentpeople_createdstatus_downtime
Analytics type (depends on metric value)
Values
totaluniqueresponse_timeresolution_timehandle_timemessagesvisitor_messagesoperator_messagesrating
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
fromtosplittimezone
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)
Whether to export data in raw format
- POSThttps://api.crisp.chat/v1/website/website_id/analytics/generate
- Tiersuser
(loading)
(loading)
Batchin Website
Batch Resolve Items
Resolves given (or all) items in website (conversations).
Inbox identifier to resolve conversations for (or none)
List of session identifiers to resolve conversation for (if empty, resolve all)
- PATCHhttps://api.crisp.chat/v1/website/website_id/batch/resolve
- Tiersuser
(loading)
(loading)
Batch Read Items
Marks given (or all) items as read in website (conversations).
Inbox identifier to resolve conversations for (or none)
List of session identifiers to read conversation for (if empty, read all)
- PATCHhttps://api.crisp.chat/v1/website/website_id/batch/read
- Tiersuser
(loading)
(loading)
Batch Remove Items
Removes given items in website (conversations or people).
Inbox identifier to resolve conversations for (or none)
List of session identifiers to remove conversation for
People removal aggregator
List of people identifiers to remove profile for
Search aggregator for profile removal
Search filter
Filter model
Values
people
Filter criterion (in model)
Filter operator
Values
eqneqexnexhasnhasswewgteltegtlt
Filter query terms
- PATCHhttps://api.crisp.chat/v1/website/website_id/batch/remove
- Tiersuser
(loading)
(loading)
Settingsin Website
Get Website Settings
Resolves the current settings for a website.
The website identifier
Website identifier
Website name
Website domain
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
Emails settings
Whether to ask users to rate support or not
Whether to notify users of transcript records for conversation or not
Whether to enable profile enrichment based on email 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 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 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 tools in chatbox
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)
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 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
- Tiersuserplugin
- Scopeswebsite:settings
(loading)
(loading)
Update Website Settings
Updates the current settings for a website.
The website identifier
Website name
Website domain
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
Emails settings
Whether to ask users to rate support or not
Whether to notify users of transcript records for conversation or not
Whether to enable profile enrichment based on email 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 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 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 tools in chatbox
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)
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 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- 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
- Tiersuserplugin
- Scopeswebsite:verify
(loading)
(loading)
Subscriptionin Plugin
List All Active Subscriptions
Lists all active plugin subscriptions on all websites, linked to payment methods owned by the user, or from websites the user is member of.
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)
Website identifier on which plugin is active
Card identifier which is used to pay the plugin subscription
- GEThttps://api.crisp.chat/v1/plugins/subscription
- Tiersuser
(loading)
(loading)
List Subscriptions For A Website
Lists plugin subscriptions for given website.
The website 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)
Website identifier on which plugin is active
- GEThttps://api.crisp.chat/v1/plugins/subscription/website_id
- Tiersuser
(loading)
(loading)
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)
- GEThttps://api.crisp.chat/v1/plugins/subscription/website_id/plugin_id
- Tiersuserplugin
(loading)
(loading)
Subscribe Website To Plugin
Subscribes a given website to a given plugin.
The website identifier
Plugin identifier to subscribe to
- POSThttps://api.crisp.chat/v1/plugins/subscription/website_id
- Tiersuser
(loading)
(loading)
Unsubscribe Plugin From Website
Unsubscribes a given plugin from a given website.
The website identifier
The plugin identifier
- DELETEhttps://api.crisp.chat/v1/plugins/subscription/website_id/plugin_id
- Tiersuser
(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)
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)
Website identifier
Subscription secret token (used to authenticate against external configuration forms)
Plugin settings for website
- 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)
Website identifier
Subscription secret token (used to authenticate against external configuration forms)
Plugin settings for website
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
- GEThttps://api.crisp.chat/v1/plugin/connect/endpoints
- Tiersplugin
(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
- Tiersuserplugin
- Scopesbucket:url
(loading)
(loading)
Animationin Media
List Animation Medias
Lists animation medias, given the search query and paging.
The animation media list is sent back asynchronously on the RTM Events channel, using the event namespace media:animation:listed.
Page number for animation paging
Page size for animation paging (between 10 and 50, defaults to 10)
Search query (if not set, trending animations are listed)
List ID (used to stamp response payload)
- GEThttps://api.crisp.chat/v1/media/animation/list/page_number
- Tiersuser
(loading)
(loading)