This reference documents internal Crisp API routes.
☢️ Those routes are solely used by Crisp apps to perform eg. account management and other tasks. This may not be shared to public users, although routes are still available for them to access through the same API endpoint than the public one.
Subscriptionin Email
Get Subscription Status
Resolves current subscription status (subscribed or unsubscribed).
Email secure hash
Private security for given email
Website identifier for email
Whether email is subscribed or not
- GEThttps://api.crisp.chat/v1/email/email_hash/subscription/key
(loading)
(loading)
Update Subscription Status
Updates current subscription status (subscribe or unsubscribe).
Email secure hash
Private security for given email
Website identifier for email
Campaign identifier to use to track the unsubscription origin (unsubscribe only)
Whether to subscribe email or not
- PATCHhttps://api.crisp.chat/v1/email/email_hash/subscription/key
(loading)
(loading)
Availabilityin User
Get User Availability
Resolves the current user availability. Useful to check if a Crisp app is currently connected to the account.
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/user/availability
- Tiersuser
(loading)
(loading)
Update User Availability
Updates the advertised user availability, for a defined period of time after which to automatically expire.
Availability type
Values
onlineawayoffline
Seconds for which the availability is valid
- PATCHhttps://api.crisp.chat/v1/user/availability
- Tiersuser
(loading)
(loading)
Get User Availability Status
Resolves the current user availability status. It differs from the raw user availability (the raw availability only tells if the user is connected on a Crisp app).
The availability status, however, tells whether the user is seen as online or offline by visitors (given his schedule and presence options).
User identifier
Availability status
Values
onlineawayoffline
- GEThttps://api.crisp.chat/v1/user/availability/status
- Tiersuser
(loading)
(loading)
Account Basein User
Get User Account
Resolves the current user account information.
User identifier
- GEThttps://api.crisp.chat/v1/user/account
- Tiersuser
(loading)
(loading)
Create User Account
Creates a new Crisp user account (operator account).
User email
User password (at least 4 characters)
User first name
User last name
Registration unique signature
Affiliates tracking identifier (if any)
User locale (if any)
- POSThttps://api.crisp.chat/v1/user/account
(loading)
(loading)
Delete User Account
Deletes user account.
User password (used to double-authenticate deletion)
- DELETEhttps://api.crisp.chat/v1/user/account
- Tiersuser
(loading)
(loading)
Account Billingin User
List All Billing Methods
Resolves the saved billing details (payment methods).
User identifier
Active payment methods
Card identifier
Name on card
Address for cardholder
Country code for cardholder
Information on cardholder
Tax identification number for cardholder (eg. European VAT number)
Email to send invoices to (eg. accountant email address, if any)
Currency in use for billing for cardholder
Secure preview of card number (the Crisp Platform only retains this mangled number)
Country code for card
Provider for card
Values
defaultmastercardvisaamexdinersclubdiscoverunionpayjcbvisaelectronmaestroforbrugsforeningendankortpaypalwire
Date when the card expires
Date when the card was added
Whether card is valid or not
Whether card is expired or not
Websites using this card as payment method
Website identifier
Name of website
Domain of website
- GEThttps://api.crisp.chat/v1/user/account/billing
- Tiersuser
(loading)
(loading)
Add New Billing Method
Adds a payment method (credit card) to the user account.
The card added acknowledgement is sent back asynchronously on the RTM Events channel, using event namespace billing:card:added. In case an error occurs when adding the card, event namespace billing:card:error will be fired. As the systems may need to submit the card to an external service for safe storage, the card may not be fully added and active when the API response is sent back; hence that asynchronous event.
Name on card
Address for cardholder
Country code for cardholder
Information on cardholder
Tax identification number for cardholder (eg. European VAT number)
Email to send invoices to (eg. accountant email address, if any)
Card number
Card CVC
Date when the card expires
Month of expiration (if 1 digit, prepend it with a zero)
Year of expiration
- POSThttps://api.crisp.chat/v1/user/account/billing
- Tiersuser
(loading)
(loading)
Get A Billing Method
Acquires information about a saved billing method (eg: credit card).
The card identifier
User identifier
Card identifier
Name on card
Address for cardholder
Country code for cardholder
Information on cardholder
Tax identification number for cardholder (eg. European VAT number)
Email to send invoices to (eg. accountant email address, if any)
Currency in use for billing for cardholder
Secure preview of card number (the Crisp Platform only retains this mangled number)
Country code for card
Provider for card
Values
defaultmastercardvisaamexdinersclubdiscoverunionpayjcbvisaelectronmaestroforbrugsforeningendankortpaypalwire
Date when the card expires
Date when the card was added
Whether card is valid or not
Whether card is expired or not
Websites using this card as payment method
Website identifier
Name of website
Domain of website
- GEThttps://api.crisp.chat/v1/user/account/billing/card_id
- Tiersuser
(loading)
(loading)
Update A Billing Method
Updates billing method information (eg: credit card).
The card identifier
Name on card
Address for cardholder
Country code for cardholder
Information on cardholder
Tax identification number for cardholder (eg. European VAT number)
Email to send invoices to (eg. accountant email address, if any)
- PATCHhttps://api.crisp.chat/v1/user/account/billing/card_id
- Tiersuser
(loading)
(loading)
Remove A Billing Method
Deletes a saved billing method.
The card identifier
- DELETEhttps://api.crisp.chat/v1/user/account/billing/card_id
- Tiersuser
(loading)
(loading)
List Invoices For Billing Method
Lists saved invoices for billing method.
The card identifier (set value to all to get all invoices)
The page number (paging if many invoices)
List of invoices
Invoice identifier (reference invoice number)
Bill identifier (lawful invoice number)
Date at which invoice was emitted
Whether invoice is paid or not
Number of times payment was retried (if failed)
Invoice identifier
Invoice currency
Due amount details
Total due as part of this invoice (in specified currency)
Contents of the invoice (per-website)
Website identifier
Name of the website
Domain of the website
Plugins paid for the website
Plugin identifier
Plugin name
Plugin individual price
Number of months paid for
Limits paid for the website
Limit identifier
Limit name
Limit individual price
Number of months paid for
Invoice payment receipt document URL (can be blank)
Paging details
Range of items returned
Number of items per page
Total number of items
- GEThttps://api.crisp.chat/v1/user/account/billing/card_id/invoices/page_number
- Tiersuser
(loading)
(loading)
Get An Invoice For Billing Method
Gets given saved invoice for billing method.
The card identifier (set value to all to get on all cards)
The invoice identifier
Invoice identifier (reference invoice number)
Bill identifier (lawful invoice number)
Date at which invoice was emitted
Whether invoice is paid or not
Number of times payment was retried (if failed)
Invoice identifier
Invoice currency
Due amount details
Total due as part of this invoice (in specified currency)
Contents of the invoice (per-website)
Website identifier
Name of the website
Domain of the website
Plugins paid for the website
Plugin identifier
Plugin name
Plugin individual price
Number of months paid for
Limits paid for the website
Limit identifier
Limit name
Limit individual price
Number of months paid for
Invoice payment receipt document URL (can be blank)
- GEThttps://api.crisp.chat/v1/user/account/billing/card_id/invoice/invoice_id
- Tiersuser
(loading)
(loading)
Link To An Authorized Billing Method
Links to an authorized billing method. Used to for services which need an external approval (eg: PayPal), and that cannot be added directly via a simple form submit. This is also used to finalize payment card setup after it gets created (and thus mark the card as valid), as the user may need to authorize the card via eg. 3D Secure.
A link to open to continue linking to the service will be dispatched to the user via the realtime socket interface (the response is asynchronous, as Crisp needs to request data to external APIs, eg: PayPal API). The response uses the event namespace billing:link:redirect
Service to be linked
Values
stripepaypal
- POSThttps://api.crisp.chat/v1/user/account/billing/link
- Tiersuser
(loading)
(loading)
Finish Linking Authorized Billing Method
Finishes the link process to an authorized billing method. Used to mark the card link as valid.
This is used after the card link redirect, to validate card authorization, eg: with PayPal pre-approved payments.
The card identifier
- POSThttps://api.crisp.chat/v1/user/account/billing/link/card_id
- Tiersuser
(loading)
(loading)
Finish Unlinking Authorized Billing Method
Finishes the unlink process to an authorized billing method. Used to cancel the link process and remove the card.
This is used after the card link redirect, to mark card authorization as rejected, eg: with PayPal pre-approved payments.
The card identifier
- DELETEhttps://api.crisp.chat/v1/user/account/billing/link/card_id
- Tiersuser
(loading)
(loading)
Account Notificationin User
Get Notification Settings
Resolves the user notification settings.
User identifier
Whether notifications are disabled or not
Whether to notify of incoming messages when user is online (in-app notifications)
Whether to notify of incoming messages when user is offline (push notifications)
Whether to notify of unread messages for conversations (email notifications)
Whether to notify of transcript records for conversations (email notifications)
Whether to notify of user ratings for conversations (email notifications)
Whether to notify of invoice payments (email notifications)
Whether to notify of new visitors on website (push notifications)
Whether to play sounds for incoming events (in-app)
- GEThttps://api.crisp.chat/v1/user/account/notification
- Tiersuser
(loading)
(loading)
Update Notification Settings
Updates the user notification settings.
Whether notifications are disabled or not
Whether to notify of incoming messages when user is online (in-app notifications)
Whether to notify of incoming messages when user is offline (push notifications)
Whether to notify of unread messages for conversations (email notifications)
Whether to notify of transcript records for conversations (email notifications)
Whether to notify of user ratings for conversations (email notifications)
Whether to notify of invoice payments (email notifications)
Whether to notify of new visitors on website (push notifications)
Whether to play sounds for incoming events (in-app)
- PATCHhttps://api.crisp.chat/v1/user/account/notification
- Tiersuser
(loading)
(loading)
Add A Notification Provider
Adds a notification provider. Used to subscribe to push notifications from Crisp for authenticated account (eg: Google Cloud Messaging, Apple Push Notification and more).
Notification identifier (key from GCM, APN or other service)
- POSThttps://api.crisp.chat/v1/user/account/notification/provider
- Tiersuser
(loading)
(loading)
Delete A Notification Provider
Deletes a notification provider. Used to invalidate an existing notification provider (eg. a Crisp mobile app unsubscribes from notifications).
The notification provider identifier
- DELETEhttps://api.crisp.chat/v1/user/account/notification/provider/notification_id
(loading)
(loading)
Account Websitesin User
List Websites
Lists the websites linked to user.
Website identifier
Website name
Website domain
Website custom logo image URL (can be blank)
Website operators (user identifiers)
Number of unread messages for website
Number of pending assigned messages for website
Number of unread messages for inboxes
Number of unread messages for website (on inbox)
Number of pending assigned messages for website (on inbox)
Scheduled website deletion request (if any)
When scheduled website deletion will be executed
- GEThttps://api.crisp.chat/v1/user/account/websites
- Tiersuser
(loading)
(loading)
Account Profilein User
Get Profile
Resolves user profile data.
User identifier
Custom avatar image URL (can be blank)
User email
User phone number (if any)
User first name
User last name
User locale (ISO 639-1)
Email verification HMAC (signed with server private key, if any)
- GEThttps://api.crisp.chat/v1/user/account/profile
- Tiersuser
(loading)
(loading)
Update Profile
Updates user profile data.
User first name
User last name
User email
User phone number
User password (do not set it if you don't need to update password)
Custom avatar image URL
User locale (ISO 639-1)
User password (used to double-authenticate email or password change)
- PATCHhttps://api.crisp.chat/v1/user/account/profile
- Tiersuser
(loading)
(loading)
Account Tokenin User
Check If Account Token Is Configured
Checks if account token is configured.
- HEADhttps://api.crisp.chat/v1/user/account/token
- Tiersuser
(loading)
(loading)
Configure Account Token
Configures account token, with the provided token secret key.
Secret key for token (Base32-encoded)
- PUThttps://api.crisp.chat/v1/user/account/token
- Tiersuser
(loading)
(loading)
Unconfigure Account Token
Unconfigures account token.
User password (used to double-authenticate unconfiguration)
- DELETEhttps://api.crisp.chat/v1/user/account/token
- Tiersuser
(loading)
(loading)
Generate Account Token
Generates a new account token secret key, to be sent upon configuration.
- POSThttps://api.crisp.chat/v1/user/account/token/generate
- Tiersuser
(loading)
(loading)
Verify Account Token
Verifies provided token against provided secret key. This can be used in TOTP configuration flows to validate the secret key before configuring it.
The token to be verified
The secret key to verify against
- HEADhttps://api.crisp.chat/v1/user/account/token/verify
- Tiersuser
(loading)
(loading)
Account Recoverin User
Get Recovery Details
Gets details on a recovery keypair. Useful to check validity of recovery keypair.
The user identifier
The recovery identifier
The recovery key
- GEThttps://api.crisp.chat/v1/user/user_id/account/recover/recover_identifier/recover_key
(loading)
(loading)
Send Recovery Password
Submits new password and recover account.
The user identifier
The recovery identifier
The recovery key
User password (at least 4 characters)
- PUThttps://api.crisp.chat/v1/user/user_id/account/recover/recover_identifier/recover_key
(loading)
(loading)
Delete Recovery Keypair
Deletes a recovery keypair. Useful to invalidate keys if you ignore recovery and never use the keys to recover password.
The user identifier
The recovery identifier
The recovery key
- DELETEhttps://api.crisp.chat/v1/user/user_id/account/recover/recover_identifier/recover_key
(loading)
(loading)
Account Schedulein User
Get Schedule Settings
Gets user schedule settings. Those settings are used by Crisp to automatically schedule when user will be seen online or offline by website visitors.
User identifier
Whether schedule is enabled or not
Whether to consider user online if using an app
Whether stealth mode is enabled or not (offline mode forced)
User timezone offset in seconds (UTC+2 is -120)
Schedule days
Consider Monday on schedule
Consider Tuesday on schedule
Consider Wednesday on schedule
Consider Thursday on schedule
Consider Friday on schedule
Consider Saturday on schedule
Consider Sunday on schedule
Schedule hours
Hour from which to consider on schedule (24:00 format)
Hour up to which to consider on schedule (24:00 format)
- GEThttps://api.crisp.chat/v1/user/account/schedule
- Tiersuser
(loading)
(loading)
Update Schedule Settings
Updates user schedule settings.
Whether schedule is enabled or not
Whether to consider user online if using an app
Whether stealth mode is enabled or not (offline mode forced)
User timezone offset in seconds (UTC+2 is -120)
Schedule days
Consider Monday on schedule
Consider Tuesday on schedule
Consider Wednesday on schedule
Consider Thursday on schedule
Consider Friday on schedule
Consider Saturday on schedule
Consider Sunday on schedule
Schedule hours
Hour from which to consider on schedule (24:00 format)
Hour up to which to consider on schedule (24:00 format)
- PATCHhttps://api.crisp.chat/v1/user/account/schedule
- Tiersuser
(loading)
(loading)
Sessionin User
Check Session Validity
Checks whether the user is logged in or not, and whether his session is valid or not.
- HEADhttps://api.crisp.chat/v1/user/session
- Tiersuser
(loading)
(loading)
Create A New Session
Logins to user account and create a new session.
User email
User password
Where to extend login to (eg. send TOTP code as SMS by extending on phone)
Values
phone
User token (6 digits TOTP, if any required)
Whether to open an ephemeral session or not (expires after a few hours)
- POSThttps://api.crisp.chat/v1/user/session/login
(loading)
(loading)
Destroy A Session
Logouts from user account and destroys current session.
- POSThttps://api.crisp.chat/v1/user/session/logout
- Tiersuser
(loading)
(loading)
Recover A Session
Recovers a user account from which we are locked out. A password recovery email is sent.
User email
- POSThttps://api.crisp.chat/v1/user/session/recover
(loading)
(loading)
List Authorized Sessions
Lists all authorized sessions. Those sessions currently exist, and can be used by an app to access the connected Crisp account.
Session identifier
Session device details (the device that was used to login)
User agent from which login occured (if any detected)
IP address from which login occured (if any detected)
Country from which login occured (if any resolved from IP address)
Session creation timestamp
- GEThttps://api.crisp.chat/v1/user/session/authorized
- Tiersuser
(loading)
(loading)
Check If Authorized Session Exists
Checks if authorized session exists.
The session identifier
- HEADhttps://api.crisp.chat/v1/user/session/authorized/identifier
- Tiersuser
(loading)
(loading)
Get Authorized Session
Resolves authorized session details.
The session identifier
Session identifier
Session device details (the device that was used to login)
User agent from which login occured (if any detected)
IP address from which login occured (if any detected)
Country from which login occured (if any resolved from IP address)
Session creation timestamp
- GEThttps://api.crisp.chat/v1/user/session/authorized/identifier
- Tiersuser
(loading)
(loading)
Close An Authorized Session
Closes an authorized session. This will prevent the connected app to access the underlying Crisp account.
The session identifier
- DELETEhttps://api.crisp.chat/v1/user/session/authorized/identifier
- Tiersuser
(loading)
(loading)
List Session History
Lists session history. This shows login history (ie. new sessions created); those sessions may still be authorized, or may be closed (ie. logged out).
Current session state
Values
authorizedclosed
Session device details (the device that was used to login)
User agent from which login occured (if any detected)
IP address from which login occured (if any detected)
Country from which login occured (if any resolved from IP address)
Session creation timestamp
- GEThttps://api.crisp.chat/v1/user/session/history
- Tiersuser
(loading)
(loading)
Get Session Confirm Details
Gets details on a session confirm keypair. Useful to check validity of session confirm keypair.
The user identifier
The session confirm identifier
The session confirm key
- GEThttps://api.crisp.chat/v1/user/user_id/session/confirm/confirm_identifier/confirm_key
(loading)
(loading)
Accept Session Confirm
Accept session login confirm request. The request origin country will be accepted.
The user identifier
The session confirm identifier
The session confirm key
IP address to be confirmed
Country code to be confirmed (if any)
- PUThttps://api.crisp.chat/v1/user/user_id/session/confirm/confirm_identifier/confirm_key
(loading)
(loading)
Delete Session Confirm Keypair
Deletes a session confirm keypair. Useful to invalidate keys if you ignore session confirm.
The user identifier
The session confirm identifier
The session confirm key
- DELETEhttps://api.crisp.chat/v1/user/user_id/session/confirm/confirm_identifier/confirm_key
(loading)
(loading)
Alertsin User
Count Unread Alerts
Counts the unread alerts, whether they are coming from feed or updates.
Number of unread feed alerts
Number of unread update alerts
- GEThttps://api.crisp.chat/v1/user/alerts/count
- Tiersuser
(loading)
(loading)
Clear All Feed Alerts
Clears off all pending alerts in the feed.
- DELETEhttps://api.crisp.chat/v1/user/alerts/feed
- Tiersuser
(loading)
(loading)
List Feed Alerts
Lists all pending alerts in the feed.
Page number for alerts paging
Unique identifier of the feed alert
Importance level of the feed alert
Values
noticeimportantcritical
Namespace of the feed alert
Values
website:agent_limit_reachedbilling:payment_method_expirebilling:payment_actionbilling:payment_errormessage:reminderwebsite:export_completehelpdesk:import_completewebsite:subscriptions_deactivatedwebsite:plan_trial_endedwebsite:agent_purged
Dynamic data associated to the feed alert (if any)
Action URL for the feed alert (if any)
Timestamp at which the feed alert was pushed
- GEThttps://api.crisp.chat/v1/user/alerts/feed/list/page_number
- Tiersuser
(loading)
(loading)
Check If Feed Alert Exists
Checks if a pending alert exists in the feed.
The feed entry identifier
- HEADhttps://api.crisp.chat/v1/user/alerts/feed/entry/feed_entry_id
- Tiersuser
(loading)
(loading)
Get A Feed Alert
Gets a pending alert in the feed.
The feed entry identifier
Unique identifier of the feed alert
Importance level of the feed alert
Values
noticeimportantcritical
Namespace of the feed alert
Values
website:agent_limit_reachedbilling:payment_method_expirebilling:payment_actionbilling:payment_errormessage:reminderwebsite:export_completehelpdesk:import_completewebsite:subscriptions_deactivatedwebsite:plan_trial_endedwebsite:agent_purged
Dynamic data associated to the feed alert (if any)
Action URL for the feed alert (if any)
Timestamp at which the feed alert was pushed
- GEThttps://api.crisp.chat/v1/user/alerts/feed/entry/feed_entry_id
- Tiersuser
(loading)
(loading)
Clear A Feed Alert
Clears off a pending alert from the feed.
The feed entry identifier
- DELETEhttps://api.crisp.chat/v1/user/alerts/feed/entry/feed_entry_id
- Tiersuser
(loading)
(loading)
List Update Alerts
Lists all updates in the feed (unread and read).
Page number for alerts paging
Unique identifier of the update alert
Importance level of the update alert
Values
noticeimportantcritical
Title for the update alert
Description for the update alert
Action URL for the update alert (if any)
Icon URL for the update alert (if any)
Whether the update alert has already been read or not
Timestamp at which the update alert was created
- GEThttps://api.crisp.chat/v1/user/alerts/updates/list/page_number
- Tiersuser
(loading)
(loading)
Resolve Latest Update Alert
Resolves latest update from the feed (the most recent update).
Unique identifier of the update alert
Importance level of the update alert
Values
noticeimportantcritical
Title for the update alert
Description for the update alert
Action URL for the update alert (if any)
Icon URL for the update alert (if any)
Whether the update alert has already been read or not
Timestamp at which the update alert was created
- GEThttps://api.crisp.chat/v1/user/alerts/updates/latest
- Tiersuser
(loading)
(loading)
Get An Update Alert Content
Gets an update alert content data in the feed (if any; this can be quite large).
The updates entry identifier
Unique identifier of the update alert
Content data for the update alert (if any)
- GEThttps://api.crisp.chat/v1/user/alerts/updates/entry/updates_entry_id/content
- Tiersuser
(loading)
(loading)
Mark All Update Alerts As Read
Marks all updates in the feed as read.
- PATCHhttps://api.crisp.chat/v1/user/alerts/updates/read
- Tiersuser
(loading)
(loading)
Statisticsin User
Count Total Unread Messages
Counts the total number of unread messages, cross-website.
User identifier
Number of unread messages for user
Number of pending assigned messages for user
- GEThttps://api.crisp.chat/v1/user/stats/unread
- Tiersuser
(loading)
(loading)
Connectin User
Get User Connect Endpoints
Resolves the user endpoints information.
Socket endpoints
RTM API WebSocket endpoint URL
- GEThttps://api.crisp.chat/v1/user/connect/endpoints
- Tiersuser
(loading)
(loading)
Billingin Website
Get Website Billing
Resolves website billing information (payment method linked to website).
The website identifier
Card identifier
Name on card
Address for cardholder
Country code for cardholder
Information on cardholder
Tax identification number for cardholder (eg. European VAT number)
Email to send invoices to (eg. accountant email address, if any)
Currency in use for billing for cardholder
Secure preview of card number (the Crisp Platform only retains this mangled number)
Country code for card
Provider for card
Values
defaultmastercardvisaamexdinersclubdiscoverunionpayjcbvisaelectronmaestroforbrugsforeningendankortpaypalwire
Date when the card expires
Date when the card was added
Whether card is valid or not
Whether card is expired or not
Card owner user
User identifier
User email
User first name
User last name
- GEThttps://api.crisp.chat/v1/website/website_id/billing
- Tiersuser
(loading)
(loading)
Update Website Billing
Updates website billing information (payment method linked to website).
The website identifier
Card identifier to link to website
- PATCHhttps://api.crisp.chat/v1/website/website_id/billing
- Tiersuser
(loading)
(loading)
Unlink Website Billing
Unlink website billing information (payment method linked to website).
The website identifier
The card identifier
- DELETEhttps://api.crisp.chat/v1/website/website_id/billing/card_id
- Tiersuser
(loading)
(loading)
Channelin Website
Get Website Email Channel
Resolves the website email channel values. The returned values are static (they do not change), as long as you do not re-configure the email channel domain. The returned email can be used to receive email messages in the Crisp inbox.
The website identifier
Website inbound email (if available)
- GEThttps://api.crisp.chat/v1/website/website_id/channel/email
- Tiersuser
(loading)
(loading)
Get Website Email Channel Domain
Resolves domain for website email channel.
The website identifier
Root domain for email domain
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/channel/email/domain
- Tiersuser
(loading)
(loading)
Request Website Email Channel Domain Change
Requests a change in the email channel domain used to send and receive emails. 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.
The website identifier
Basic domain (subdomain of on.crisp.email)
Custom domain (fully qualified domain, can be blank)
- PATCHhttps://api.crisp.chat/v1/website/website_id/channel/email/domain
- Tiersuser
(loading)
(loading)
Generate Website Email Channel Setup Flow
Retrieves the email channel setup flow. This will return the DNS records required for email domain setup.
The website identifier
Domain to use for setup
Mailer domain to return setup for
Setup flow for mailer domain
DNS records for mailer 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/channel/email/setup
- Tiersuser
(loading)
(loading)
Get Website Email Channel Relay
Resolves the website email channel relay store. If any SMTP relay is configured, the outbound emails will be routed using specified SMTP server.
This route requires a custom email channel domain to be configured.
The website identifier
SMTP relay connection status (from last delivered email)
Values
inactiveactivefailed
SMTP relay server credentials (if any)
SMTP server username (if any)
SMTP server host
SMTP server port
- GEThttps://api.crisp.chat/v1/website/website_id/channel/email/relay
- Tiersuser
(loading)
(loading)
Request Website Email Channel Relay Change
Requests a change in the email channel relay store (which is used to deliver emails). The change will be propagated once the provided SMTP credentials are verified.
This route requires a custom email channel domain to be configured.
The website identifier
SMTP relay server credentials (can be blank)
SMTP server username (can be blank)
SMTP server password (can be blank)
SMTP server host
SMTP server port
- PATCHhttps://api.crisp.chat/v1/website/website_id/channel/email/relay
- Tiersuser
(loading)
(loading)
Resolve Website Email Channel Signature
Resolves the website email channel signature, that gets sent at the end of every email for the website.
The website identifier
Signature text (if any)
- GEThttps://api.crisp.chat/v1/website/website_id/channel/email/signature
- Tiersuser
(loading)
(loading)
Save Website Email Channel Signature
Saves the website email channel signature.
The website identifier
Signature text (can be blank)
- PATCHhttps://api.crisp.chat/v1/website/website_id/channel/email/signature
- Tiersuser
(loading)
(loading)
Get Website Email Channel IP
Resolves the website email channel IP address. The IP address can be either pooled (default), or assigned to the website (paid option). In the latter case, the website enjoys a dedicated IP address, and can increase its deliverability.
This route requires a custom email channel domain to be configured, as well as the email IP plugin to be subscribed.
The website identifier
Pooled IP data
Currently-used pool reputation (percentage, from 0 to 100)
Assigned IP data (if any)
Reputation of the assigned IP address (percentage, from 0 to 100)
List of assigned IP addresses
IP address type (IPv4 or IPv6)
Values
V4V6
IP address value
Hostname for the IP address (reverse DNS of the IP address)
Statistics for the assigned IP address (this month)
Number of users who unsubscribed from emails sent from website
Number of emails sent from assigned IP
- GEThttps://api.crisp.chat/v1/website/website_id/channel/email/ip
- Tiersuser
(loading)
(loading)
Assign Website Email Channel IP
Requests a website email channel IP address to be assigned for the website. The IP address will be reserved from the pool of private IP addresses Crisp maintains.
This route requires a custom email channel domain to be configured, as well as the email IP plugin to be subscribed.
The website identifier
- POSThttps://api.crisp.chat/v1/website/website_id/channel/email/ip/assigned
- Tiersuser
(loading)
(loading)
Unassign Website Email Channel IP
Unassign currently-assigned email IP for website. The assigned IP will be released, and the website will be back using a pooled email IP.
The website identifier
- DELETEhttps://api.crisp.chat/v1/website/website_id/channel/email/ip/assigned
- Tiersuser
(loading)
(loading)
List Website Email Channel IP Logs
Lists latest website email channel IP logs. Those are raw error logs of failed email delivery to an address. They may help find out why an email was not delivered to a third-party.
The website identifier
Content for the email log line (raw log, ie. unfiltered)
Timestamp for email log line
- GEThttps://api.crisp.chat/v1/website/website_id/channel/email/ip/logs
- Tiersuser
(loading)
(loading)
Contractsin Website
List Website Contracts
Lists all contracts agreed or not for website.
The website identifier
Contract identifier
Contract title
Contract URL (baseline non-agreed contract)
Contract agreement URL (agreed contract, if any)
Contract description
- GEThttps://api.crisp.chat/v1/website/website_id/contracts
- Tiersuser
(loading)
(loading)
Contractin Website
Check If Agreed Website Contract Exists
Checks if an agreed contract exists for website.
The website identifier
- HEADhttps://api.crisp.chat/v1/website/website_id/contract/contract_id
- Tiersuser
(loading)
(loading)
Resolve Agreed Website Contract
Resolves an agreed contract for website.
The website identifier
Contract identifier
Contract title
Contract URL (baseline non-agreed contract)
Contract agreement URL (agreed contract, if any)
Contract description
- GEThttps://api.crisp.chat/v1/website/website_id/contract/contract_id
- Tiersuser
(loading)
(loading)
Agree To Website Contract
Agrees to a contract for website.
The website identifier
Contract agreement URL (agreed contract)
- PUThttps://api.crisp.chat/v1/website/website_id/contract/contract_id
- Tiersuser
(loading)
(loading)
Delete Agreed Website Contract
Deletes an agreed contract for website.
The website identifier
- DELETEhttps://api.crisp.chat/v1/website/website_id/contract/contract_id
- Tiersuser
(loading)
(loading)
Datain Website
Refresh Website Predict Data
Refreshes website predict data. This can be used to train the AI with new data from the Crisp inbox.
The website identifier
- PUThttps://api.crisp.chat/v1/website/website_id/data/predict/refresh
- Tiersuser
(loading)
(loading)
Invitein Website
Get Invite Details
Gets details on a invite keypair. Useful to check validity of invite keypair.
The website identifier
The invite identifier
The invite key
Invite email (doesn't need to match when redeeming later)
Invite role
Invited website
Website identifier
Website name
Website domain
Website custom logo image URL (can be blank)
- GEThttps://api.crisp.chat/v1/website/website_id/invite/invite_identifier/invite_key
(loading)
(loading)
Redeem Invite
Redeems invite and join the website as operator.
The website identifier
The invite identifier
The invite key
- PUThttps://api.crisp.chat/v1/website/website_id/invite/invite_identifier/invite_key
- Tiersuser
(loading)
(loading)
Delete Invite Keypair
Deletes an invite keypair. Useful to invalidate keys if you ignore invite and never use the keys to redeem invite.
The website identifier
The invite identifier
The invite key
- DELETEhttps://api.crisp.chat/v1/website/website_id/invite/invite_identifier/invite_key
(loading)
(loading)
Sandboxin Website
Check If Sandbox Target Exists
Checks if sandbox target exists.
The website identifier
The sandbox user identifier
- HEADhttps://api.crisp.chat/v1/website/website_id/sandbox/user_id
- Tiersuser
(loading)
(loading)
Delete Sandbox Target
Deletes a sandbox target. Useful to revoke Marketplace developers access to the website.
The website identifier
The sandbox user identifier
- DELETEhttps://api.crisp.chat/v1/website/website_id/sandbox/user_id
- Tiersuser
(loading)
(loading)
Usagein Website
Resolve Quotas Usage
Resolves all current quotas usage for website.
The website identifier
Namespace for the quota
Namespace type
Namespace classifier
Quota status data
Number of times the quota has been consumed for current period
Quota threshold per period (ie. total number of quota consumes allowed)
Time after which a quota period ends up (in seconds)
Contextual values that are used to compute the total limit
Number of quota entries included in the subscribed plan
Time divider used to compute the quota value (eg. if the value is billed monthly but used weekly in practice)
Associated limit, which can be subscribed to in order to increase quota (if any)
Limit identifier
- GEThttps://api.crisp.chat/v1/website/website_id/usage/quotas
- Tiersuser
(loading)
(loading)
Resolve Limits Usage
Resolves all current limits usage for website.
The website identifier
Namespace for the limit
Namespace type
Namespace classifier
Limit details (if any associated limit)
Limit identifier for the associated limit, which can be subscribed to in order to increase limit
Actual website usage for the limit (if usage can be measured for the namespace)
Maximum usage allowed for the current limit subscription (this can be increased by subscribing to higher limits)
Contextual values that are used to compute the total limit
Number of limit entries included in the subscribed plan (if any)
- GEThttps://api.crisp.chat/v1/website/website_id/usage/limits
- Tiersuser
(loading)
(loading)
Ratingin Website
Map Session Rating Stars
Map session ratings stars for website.
The website identifier
When to start relative to rating creation date (date, ISO 8601)
When to end relative to rating creation date (date, ISO 8601)
Stars map
Number of 1-star ratings left
Number of 2-stars ratings left
Number of 3-stars ratings left
Number of 4-stars ratings left
Number of 5-stars ratings left
Number of comments left
- GEThttps://api.crisp.chat/v1/website/website_id/rating/sessions/stars
- Tiersuser
(loading)
(loading)
List Session Ratings
Lists session ratings for website.
The website identifier
The page number (paging in ratings list)
When to start relative to rating creation date (date, ISO 8601)
When to end relative to rating creation date (date, ISO 8601)
Number of stars for rating, from 1 to 5
Comment for rating
Rating author (if any)
Session identifier for rating author
Nickname for rating author
Email for rating author
Avatar for rating author
Geolocation for rating author
Country code
Region code
City name
Location coordinates
Latitude coordinate
Longitude coordinate
Assigned operator (if any)
Operator user identifier
Rating creation timestamp
- GEThttps://api.crisp.chat/v1/website/website_id/rating/sessions/list/page_number
- Tiersuser
(loading)
(loading)
Resolve Session Rating
Gets a session rating for website. Used to retrieve rating details from a given session.
The website identifier
The session identifier
Number of stars for rating, from 1 to 5
Comment for rating
Rating author (if any)
Session identifier for rating author
Nickname for rating author
Email for rating author
Avatar for rating author
Geolocation for rating author
Country code
Region code
City name
Location coordinates
Latitude coordinate
Longitude coordinate
Assigned operator (if any)
Operator user identifier
Rating creation timestamp
- GEThttps://api.crisp.chat/v1/website/website_id/rating/session/session_id
(loading)
(loading)
Submit Session Rating
Submits a session rating for website. Used for session users to publish their own website rating.
The website identifier
The session identifier
Number of stars for rating, from 1 to 5
Comment for rating
- PUThttps://api.crisp.chat/v1/website/website_id/rating/session/session_id
(loading)
(loading)
Delete Session Rating
Deletes a session rating for website. Used for session users to revoke their own website rating.
The website identifier
The session identifier
- DELETEhttps://api.crisp.chat/v1/website/website_id/rating/session/session_id
(loading)
(loading)
Routingin Website
Get Website Routing Settings
Resolves the routing settings for a website.
The website identifier
Routing assign status (ie. whether to enable rules or not)
Whether to assign operator who replied upon reply
Whether to reprocess rules periodically on new messages (if conversation has already an assigned operator)
Whether to reprocess rules if assigned operator is offline
- GEThttps://api.crisp.chat/v1/website/website_id/routing/settings
- Tiersuser
(loading)
(loading)
Update Website Routing Settings
Updates the routing settings for a website.
The website identifier
Routing assign status (ie. whether to enable rules or not)
Whether to assign operator who replied upon reply
Whether to reprocess rules periodically on new messages (if conversation has already an assigned operator)
Whether to reprocess rules if assigned operator is offline
- PATCHhttps://api.crisp.chat/v1/website/website_id/routing/settings
- Tiersuser
(loading)
(loading)
List Website Routing Rules
Lists the routing rules for a website.
The website identifier
Routing rules
Rule name
Routing conditions filter
Filter model
Values
session
Filter criterion (in model)
Filter operator
Values
eqneqgteltegtlt
Filter query terms
User identifiers of operators to be assigned
- GEThttps://api.crisp.chat/v1/website/website_id/routing/rules
- Tiersuser
(loading)
(loading)
Save Website Routing Rules
Saves the routing rules for a website.
The website identifier
Routing rules
Rule name
Routing conditions filter
Filter model
Values
session
Filter criterion (in model)
Filter operator
Values
eqneqgteltegtlt
Filter query terms
User identifiers of operators to be assigned
- PUThttps://api.crisp.chat/v1/website/website_id/routing/rules
- Tiersuser
(loading)
(loading)
Inboxin Website
List Website Inboxes
Lists all inboxes for website.
The website identifier
The page number (paging in inbox list)
Inbox identifier
Inbox name
Inbox emoji
Inbox order
Operator user identifiers (members of the inbox)
Filtering conditions
Filter model
Values
session
Filter criterion (in model)
Filter operator
Values
eqneqgteltegtlt
Filter query terms
Inbox creation timestamp
Inbox update timestamp
- GEThttps://api.crisp.chat/v1/website/website_id/inboxes/list/page_number
- Tiersuser
(loading)
(loading)
Batch Order Website Inboxes
Changes order for multiple matching inboxes on website.
The website identifier
Re-ordering operations
Inbox identifier
Order of inbox
- PATCHhttps://api.crisp.chat/v1/website/website_id/inboxes/batch/order
- Tiersuser
(loading)
(loading)
Create A New Website Inbox
Creates a new inbox for website.
The website identifier
Inbox name
Inbox emoji
Inbox order
Operator user identifiers (members of the inbox)
Filtering conditions
Filter model
Values
session
Filter criterion (in model)
Filter operator
Values
eqneqgteltegtlt
Filter query terms
- POSThttps://api.crisp.chat/v1/website/website_id/inbox
- Tiersuser
(loading)
(loading)
Check If Website Inbox Exists
Checks if inbox exists for website.
The website identifier
The inbox identifier
- HEADhttps://api.crisp.chat/v1/website/website_id/inbox/inbox_id
- Tiersuser
(loading)
(loading)
Get Website Inbox
Resolves inbox for website.
The website identifier
The inbox identifier
Inbox identifier
Inbox name
Inbox emoji
Inbox order
Operator user identifiers (members of the inbox)
Filtering conditions
Filter model
Values
session
Filter criterion (in model)
Filter operator
Values
eqneqgteltegtlt
Filter query terms
Inbox creation timestamp
Inbox update timestamp
- GEThttps://api.crisp.chat/v1/website/website_id/inbox/inbox_id
- Tiersuser
(loading)
(loading)
Save Website Inbox
Saves inbox for website.
The website identifier
The inbox identifier
Inbox name
Inbox emoji
Inbox order
Operator user identifiers (members of the inbox)
Filtering conditions
Filter model
Values
session
Filter criterion (in model)
Filter operator
Values
eqneqgteltegtlt
Filter query terms
- PUThttps://api.crisp.chat/v1/website/website_id/inbox/inbox_id
- Tiersuser
(loading)
(loading)
Delete Website Inbox
Deletes inbox for website.
The website identifier
The inbox identifier
- DELETEhttps://api.crisp.chat/v1/website/website_id/inbox/inbox_id
- Tiersuser
(loading)
(loading)
Setupin Website
Get Website Setup
Resolves the setup state for a website.
The website identifier
Whether setup flow is disabled or not
Setup states
Setup state for chatbox
Whether chatbox setup is done or not
Trial days added for chatbox setup
Setup state for Messenger
Whether Messenger setup is done or not
Trial days added for Messenger setup
Setup state for email
Whether email setup is done or not
Trial days added for email setup
Setup state for Slack
Whether Slack setup is done or not
Trial days added for Slack setup
Setup state for Triggers
Whether Triggers setup is done or not
Trial days added for Triggers setup
Setup state for Helpdesk
Whether Helpdesk setup is done or not
Trial days added for Helpdesk setup
Setup state for Bot
Whether Bot setup is done or not
Trial days added for Bot setup
Setup state for MagicReply
Whether MagicReply setup is done or not
Trial days added for MagicReply setup
- GEThttps://api.crisp.chat/v1/website/website_id/setup
- Tiersuser
(loading)
(loading)
Update Website Setup
Updates the setup state for a website.
The website identifier
Whether setup flow is disabled or not
- PATCHhttps://api.crisp.chat/v1/website/website_id/setup
- Tiersuser
(loading)
(loading)
Searchin Website
List Website Search History
Lists the search history for a website.
The website identifier
History entry identifier
History entry query
History entry creation timestamp
- GEThttps://api.crisp.chat/v1/website/website_id/search/history/list
- Tiersuser
(loading)
(loading)
Insert Website Search History Entry
Inserts a new entry in the search history for a website.
The website identifier
History entry query
- POSThttps://api.crisp.chat/v1/website/website_id/search/history/entry
- Tiersuser
(loading)
(loading)
Check If Website Search History Entry Exists
Checks if a search history entry exists for a website.
The website identifier
The history identifier
- HEADhttps://api.crisp.chat/v1/website/website_id/search/history/entry/history_id
- Tiersuser
(loading)
(loading)
Get Website Search History Entry
Resolves a search history entry for a website.
The website identifier
The history identifier
History entry identifier
History entry query
History entry creation timestamp
- GEThttps://api.crisp.chat/v1/website/website_id/search/history/entry/history_id
- Tiersuser
(loading)
(loading)
Delete Website Search History Entry
Deletes a search history entry for a website.
The website identifier
The history identifier
- DELETEhttps://api.crisp.chat/v1/website/website_id/search/history/entry/history_id
- Tiersuser
(loading)
(loading)
Statesin Website
Request Website States
Requests website states to be pushed to clients connected to realtime socket. States are both current operator message compose details and currently opened conversations (from online operators).
The state responses are sent back asynchronously on the RTM Events channel.
The website identifier
- GEThttps://api.crisp.chat/v1/website/website_id/states
- Tiersuser
(loading)
(loading)
Servicein Website
Request Translation Service
Requests a translation service (eg. translate a text message).
The translated result is sent back asynchronously on the RTM Events channel, using the event namespace service:translate:processed.
The website identifier
Tracking ID, returned in asynchronous callback
Source and destination locales for translation
Source locale (ISO 639-1)
Destination locale (ISO 639-1)
Source text to translate
- POSThttps://api.crisp.chat/v1/website/website_id/service/translate
- Tiersuser
(loading)
(loading)
Request Transcription Service
Requests a transcription service (eg. transcribe an audio speech message to text).
The transcribed result is sent back asynchronously on the RTM Events channel, using the event namespace service:transcribe:processed.
The website identifier
Tracking ID, returned in asynchronous callback
Source and destination locales for transcription
Text destination locale (ISO 639-1)
Source audio media to transcribe
Audio file MIME type (must be an audio/* type)
Audio file URL
- POSThttps://api.crisp.chat/v1/website/website_id/service/transcribe
- Tiersuser
(loading)
(loading)
Request Extraction Service
Requests extraction service (eg. extract condensed questions from a conversation).
The extracted result is sent back asynchronously on the RTM Events channel, using the event namespace service:extract:processed.
The website identifier
Tracking ID, returned in asynchronous callback
Extraction action to be applied on history
Values
condensesummarize
History of exchanges (possibly between more than 2 parties)
Exchange direction
Values
useroperator
Name of exchange entry author
Exchange text content
- POSThttps://api.crisp.chat/v1/website/website_id/service/extract
- Tiersuser
(loading)
(loading)
Request Prediction Service
Requests a prediction service (eg. predict a text message reply based on conversation context).
The predicted result is sent back asynchronously on the RTM Events channel, using the event namespace service:predict:processed. While processing, intermediate results are sent via service:predict:partial.
The website identifier
Tracking ID, returned in asynchronous callback
Data source used for search and prediction (if none given, all data sources will be used)
Values
inboxanswerwebpagehelpdesk
Target recipient for the predicted answer (defaults to user if none set)
Values
useroperator
Context for prediction
Sender name
Recipient name
History of exchanges between sender and recipient
Exchange direction
Values
useroperator
Exchange text content
Text to expand when computing prediction (ie. prediction will start with this text)
- POSThttps://api.crisp.chat/v1/website/website_id/service/predict
- Tiersuser
(loading)
(loading)
Request Ranking Service
Requests a ranking service (eg. rank a text message containing a question, from a data source eg. a Crisp Helpdesk).
The ranked result is sent back asynchronously on the RTM Events channel, using the event namespace service:rank:processed.
The website identifier
Tracking ID, returned in asynchronous callback
Data source used for search and ranking
Values
helpdesk
Text to use as a question when looking up for ranked answers
- POSThttps://api.crisp.chat/v1/website/website_id/service/rank
- Tiersuser
(loading)
(loading)
Request Transform Service
Requests a transform service (eg. rephrase a text, or convert text to a friendly tone).
The transformed result is sent back asynchronously on the RTM Events channel, using the event namespace service:transform:processed.
The website identifier
Tracking ID, returned in asynchronous callback
Action for transforming
Values
expandreaddressimprove:rephraseimprove:grammartone:friendlytone:formal
Text to transform
- POSThttps://api.crisp.chat/v1/website/website_id/service/transform
- Tiersuser
(loading)
(loading)
Hooksin Website
List Hooks
Lists hooks for website.
The website identifier
Page number for hooks paging
Hook identifier
Hook label
Hook target URL
Hook status (from last sent event)
Values
inactiveactivefailed
Hook event namespaces (to receive on target)
Values
message:updatedmessage:sendmessage:receivedmessage:removedmessage:acknowledge:read:sendmessage:acknowledge:read:receivedmessage:notify:unread:sendmessage:notify:unread:receivedsession:set_emailsession:set_phonesession:set_addresssession:set_subjectsession:set_datasession:set_avatarsession:set_nicknamesession:set_statesession:set_blocksession:set_segmentssession:removedsession:sync:geolocationsession:sync:systemsession:sync:networksession:sync:timezonesession:sync:localessession:sync:eventssession:sync:ratingsession:sync:topicpeople:profile:createdpeople:profile:updatedpeople:profile:removedpeople:bind:sessionpeople:sync:profilecampaign:progresscampaign:dispatchedcampaign:runningstatus:health:changedemail:subscribeemail:track:viewplugin:event
Timestamp at which the last hook delivery attempt occurred (if any)
- GEThttps://api.crisp.chat/v1/website/website_id/hooks/page_number
- Tiersuser
(loading)
(loading)
Hookin Website
Create A New Hook
Creates a new hook.
The website identifier
Hook label
Hook target URL
Hook event namespaces (to receive on target)
Values
message:updatedmessage:sendmessage:receivedmessage:removedmessage:acknowledge:read:sendmessage:acknowledge:read:receivedmessage:notify:unread:sendmessage:notify:unread:receivedsession:set_emailsession:set_phonesession:set_addresssession:set_subjectsession:set_datasession:set_avatarsession:set_nicknamesession:set_statesession:set_blocksession:set_segmentssession:removedsession:sync:geolocationsession:sync:systemsession:sync:networksession:sync:timezonesession:sync:localessession:sync:eventssession:sync:ratingsession:sync:topicpeople:profile:createdpeople:profile:updatedpeople:profile:removedpeople:bind:sessionpeople:sync:profilecampaign:progresscampaign:dispatchedcampaign:runningstatus:health:changedemail:subscribeemail:track:viewplugin:event
- POSThttps://api.crisp.chat/v1/website/website_id/hook
- Tiersuser
(loading)
(loading)
Check If Hook Exists
Checks if given hook exists.
The website identifier
The hook identifier
- HEADhttps://api.crisp.chat/v1/website/website_id/hook/hook_id
- Tiersuser
(loading)
(loading)
Get A Hook
Resolves hook information.
The website identifier
The hook identifier
Hook identifier
Hook label
Hook target URL
Hook status (from last sent event)
Values
inactiveactivefailed
Hook event namespaces (to receive on target)
Values
message:updatedmessage:sendmessage:receivedmessage:removedmessage:acknowledge:read:sendmessage:acknowledge:read:receivedmessage:notify:unread:sendmessage:notify:unread:receivedsession:set_emailsession:set_phonesession:set_addresssession:set_subjectsession:set_datasession:set_avatarsession:set_nicknamesession:set_statesession:set_blocksession:set_segmentssession:removedsession:sync:geolocationsession:sync:systemsession:sync:networksession:sync:timezonesession:sync:localessession:sync:eventssession:sync:ratingsession:sync:topicpeople:profile:createdpeople:profile:updatedpeople:profile:removedpeople:bind:sessionpeople:sync:profilecampaign:progresscampaign:dispatchedcampaign:runningstatus:health:changedemail:subscribeemail:track:viewplugin:event
Timestamp at which the last hook delivery attempt occurred (if any)
- GEThttps://api.crisp.chat/v1/website/website_id/hook/hook_id
- Tiersuser
(loading)
(loading)
Save A Hook
Saves a hook in website, and overwrite previous hook information.
The website identifier
The hook identifier
Hook label
Hook target URL
Hook event namespaces (to receive on target)
Values
message:updatedmessage:sendmessage:receivedmessage:removedmessage:acknowledge:read:sendmessage:acknowledge:read:receivedmessage:notify:unread:sendmessage:notify:unread:receivedsession:set_emailsession:set_phonesession:set_addresssession:set_subjectsession:set_datasession:set_avatarsession:set_nicknamesession:set_statesession:set_blocksession:set_segmentssession:removedsession:sync:geolocationsession:sync:systemsession:sync:networksession:sync:timezonesession:sync:localessession:sync:eventssession:sync:ratingsession:sync:topicpeople:profile:createdpeople:profile:updatedpeople:profile:removedpeople:bind:sessionpeople:sync:profilecampaign:progresscampaign:dispatchedcampaign:runningstatus:health:changedemail:subscribeemail:track:viewplugin:event
- PUThttps://api.crisp.chat/v1/website/website_id/hook/hook_id
- Tiersuser
(loading)
(loading)
Update A Hook
Updates a hook in website, and save only changed fields.
The website identifier
The hook identifier
Hook label
Hook target URL
Hook event namespaces (to receive on target)
Values
message:updatedmessage:sendmessage:receivedmessage:removedmessage:acknowledge:read:sendmessage:acknowledge:read:receivedmessage:notify:unread:sendmessage:notify:unread:receivedsession:set_emailsession:set_phonesession:set_addresssession:set_subjectsession:set_datasession:set_avatarsession:set_nicknamesession:set_statesession:set_blocksession:set_segmentssession:removedsession:sync:geolocationsession:sync:systemsession:sync:networksession:sync:timezonesession:sync:localessession:sync:eventssession:sync:ratingsession:sync:topicpeople:profile:createdpeople:profile:updatedpeople:profile:removedpeople:bind:sessionpeople:sync:profilecampaign:progresscampaign:dispatchedcampaign:runningstatus:health:changedemail:subscribeemail:track:viewplugin:event
- PATCHhttps://api.crisp.chat/v1/website/website_id/hook/hook_id
- Tiersuser
(loading)
(loading)
Remove A Hook
Removes a hook in website.
The website identifier
The hook identifier
- DELETEhttps://api.crisp.chat/v1/website/website_id/hook/hook_id
- Tiersuser
(loading)
(loading)
Filtersin Website
List Filters
Lists filters for website.
The website identifier
Page number for filters paging
Filters type to return (conversation or people)
Filter identifier
Filter type
Values
conversationpeople
Filter label
Filter data
Filter model
Values
conversationpeople
Filter criterion (in model)
Filter operator
Values
eqneqexnexhasnhasswewgteltegtlt
Filter query terms
Filter operator
Values
andor
- GEThttps://api.crisp.chat/v1/website/website_id/filters/page_number
- Tiersuser
(loading)
(loading)
Filterin Website
Create A New Filter
Creates a new filter.
The website identifier
Filter type
Values
conversationpeople
Filter label
Filter data
Filter model
Values
conversationpeople
Filter criterion (in model)
Filter operator
Values
eqneqexnexhasnhasswewgteltegtlt
Filter query terms
Filter operator
Values
andor
- POSThttps://api.crisp.chat/v1/website/website_id/filter
- Tiersuser
(loading)
(loading)
Check If Filter Exists
Checks if given filter exists.
The website identifier
The filter identifier
- HEADhttps://api.crisp.chat/v1/website/website_id/filter/filter_id
- Tiersuser
(loading)
(loading)
Get A Filter
Resolves filter information.
The website identifier
The filter identifier
Filter identifier
Filter type
Values
conversationpeople
Filter label
Filter data
Filter model
Values
conversationpeople
Filter criterion (in model)
Filter operator
Values
eqneqexnexhasnhasswewgteltegtlt
Filter query terms
Filter operator
Values
andor
- GEThttps://api.crisp.chat/v1/website/website_id/filter/filter_id
- Tiersuser
(loading)
(loading)
Save A Filter
Saves a filter in website, and overwrite previous filter information.
The website identifier
The filter identifier
Filter label
Filter data
Filter model
Values
conversationpeople
Filter criterion (in model)
Filter operator
Values
eqneqexnexhasnhasswewgteltegtlt
Filter query terms
Filter operator
Values
andor
- PUThttps://api.crisp.chat/v1/website/website_id/filter/filter_id
- Tiersuser
(loading)
(loading)
Remove A Filter
Removes a filter in website.
The website identifier
The filter identifier
- DELETEhttps://api.crisp.chat/v1/website/website_id/filter/filter_id
- Tiersuser
(loading)
(loading)
Shortcutsin Website
List Shortcuts
Lists shortcuts for website.
The website identifier
Page number for shortcuts paging
Search query in all shortcuts
Restrict search to tag
Shortcut identifier
Shortcut bang
Shortcut text
Shortcut tag
Whether shortcut is disabled or not
- GEThttps://api.crisp.chat/v1/website/website_id/shortcuts/list/page_number
- Tiersuser
(loading)
(loading)
List Shortcut Tags
Lists shortcut tags for website.
The website identifier
Shortcut tags
- GEThttps://api.crisp.chat/v1/website/website_id/shortcuts/tags
- Tiersuser
(loading)
(loading)
Batch Rename Shortcuts Tag
Renames tags for all shortcuts matching tag name with a replacement tag for website.
The website identifier
Tag name to match (or none)
Tag name to use instead (or none)
- PATCHhttps://api.crisp.chat/v1/website/website_id/shortcuts/batch/tag
- Tiersuser
(loading)
(loading)
Shortcutin Website
Create A New Shortcut
Creates a new shortcut.
The website identifier
Shortcut bang
Shortcut text
Shortcut tag
Whether shortcut is disabled or not
- POSThttps://api.crisp.chat/v1/website/website_id/shortcut
- Tiersuser
(loading)
(loading)
Check If Shortcut Exists
Checks if given shortcut exists.
The website identifier
The shortcut identifier
- HEADhttps://api.crisp.chat/v1/website/website_id/shortcut/shortcut_id
- Tiersuser
(loading)
(loading)
Get A Shortcut
Resolves shortcut information.
The website identifier
The shortcut identifier
Shortcut identifier
Shortcut bang
Shortcut text
Shortcut tag
Whether shortcut is disabled or not
- GEThttps://api.crisp.chat/v1/website/website_id/shortcut/shortcut_id
- Tiersuser
(loading)
(loading)
Save A Shortcut
Saves a shortcut in website, and overwrite previous shortcut information.
The website identifier
The shortcut identifier
Shortcut bang
Shortcut text
Shortcut tag
Whether shortcut is disabled or not
- PUThttps://api.crisp.chat/v1/website/website_id/shortcut/shortcut_id
- Tiersuser
(loading)
(loading)
Update A Shortcut
Updates a shortcut in website, and save only changed fields.
The website identifier
The shortcut identifier
Shortcut bang
Shortcut text
Shortcut tag
Whether shortcut is disabled or not
- PATCHhttps://api.crisp.chat/v1/website/website_id/shortcut/shortcut_id
- Tiersuser
(loading)
(loading)
Remove A Shortcut
Removes a shortcut in website.
The website identifier
The shortcut identifier
- DELETEhttps://api.crisp.chat/v1/website/website_id/shortcut/shortcut_id
- Tiersuser
(loading)
(loading)
Report Shortcut Action
Reports an action on a shortcut (eg. shortcut has been used). This is used for analytics purposes.
The website identifier
The shortcut identifier
Shortcut action
- POSThttps://api.crisp.chat/v1/website/website_id/shortcut/shortcut_id/report
- Tiersuser
(loading)
(loading)
Snippetsin Website
List Answer Snippets
Lists answer snippets for website.
The website identifier
The page number (paging in answers list)
Answer snippet identifier
Answer title
Answer content
Answer locale code (if any, ISO 639-1)
Answer group (if any)
Whether answer snippet is disabled or not
- GEThttps://api.crisp.chat/v1/website/website_id/snippets/answers/list/page_number
- Tiersuser
(loading)
(loading)
Add A New Answer Snippet
Creates a new answer snippet for website.
The website identifier
Answer title
Answer locale code (ISO 639-1)
- POSThttps://api.crisp.chat/v1/website/website_id/snippets/answer
- Tiersuser
(loading)
(loading)
Check If Answer Snippet Exists
Checks if answer snippet exists for website.
The website identifier
The answer snippet identifier
- HEADhttps://api.crisp.chat/v1/website/website_id/snippets/answer/answer_snippet_id
- Tiersuser
(loading)
(loading)
Resolve Answer Snippet
Resolves answer snippet for website.
The website identifier
The answer snippet identifier
Answer snippet identifier
Answer title
Answer content
Answer locale code (if any, ISO 639-1)
Answer group (if any)
Whether answer snippet is disabled or not
- GEThttps://api.crisp.chat/v1/website/website_id/snippets/answer/answer_snippet_id
- Tiersuser
(loading)
(loading)
Update Answer Snippet
Updates answer snippet for website.
The website identifier
The answer snippet identifier
Answer title
Answer content
Answer locale code (ISO 639-1)
Answer group (set to blank value for none)
Whether answer snippet is disabled or not
- PATCHhttps://api.crisp.chat/v1/website/website_id/snippets/answer/answer_snippet_id
- Tiersuser
(loading)
(loading)
Delete Answer Snippet
Deletes answer snippet for website.
The website identifier
The answer snippet identifier
- DELETEhttps://api.crisp.chat/v1/website/website_id/snippets/answer/answer_snippet_id
- Tiersuser
(loading)
(loading)
List Webpage Domains
Lists webpage domains for website.
The website identifier
Domain snippet identifier
Domain name
Pages for domain
Pages statistics for domain
Total number of pages for domain
Number of disabled pages for domain
Pages status for domain
Pages crawl state
Values
inactiverefreshingsuccessfailure
Timestamp since when the crawl status has been updated
Whether domain snippet is disabled or not
- GEThttps://api.crisp.chat/v1/website/website_id/snippets/webpages/domains
- Tiersuser
(loading)
(loading)
Add A New Webpage Domain
Creates a new webpage domain for website.
The crawling results are sent back asynchronously on the RTM Events channel, using either event namespace snippet:webpage:domain:crawl:progress or snippet:webpage:domain:crawl:done.
The website identifier
Webpage root domain
- POSThttps://api.crisp.chat/v1/website/website_id/snippets/webpages/domain
- Tiersuser
(loading)
(loading)
Check If Webpage Domain Exists
Checks if webpage domain exists for website.
The website identifier
The webpage domain snippet identifier
- HEADhttps://api.crisp.chat/v1/website/website_id/snippets/webpages/domain/domain_snippet_id
- Tiersuser
(loading)
(loading)
Resolve Webpage Domain
Resolves webpage domain for website.
The website identifier
The webpage domain snippet identifier
Domain snippet identifier
Domain name
Pages for domain
Pages statistics for domain
Total number of pages for domain
Number of disabled pages for domain
Pages status for domain
Pages crawl state
Values
inactiverefreshingsuccessfailure
Timestamp since when the crawl status has been updated
Whether domain snippet is disabled or not
- GEThttps://api.crisp.chat/v1/website/website_id/snippets/webpages/domain/domain_snippet_id
- Tiersuser
(loading)
(loading)
Update Webpage Domain
Updates webpage domain for website.
The website identifier
The webpage domain snippet identifier
Whether webpage domain is disabled or not (ie. all children pages)
- PATCHhttps://api.crisp.chat/v1/website/website_id/snippets/webpages/domain/domain_snippet_id
- Tiersuser
(loading)
(loading)
Refresh Webpage Domain
Refreshes webpage domain for website. This creates a new scraping background job, refreshing all indexed pages.
The crawling results are sent back asynchronously on the RTM Events channel, using either event namespace snippet:webpage:domain:crawl:progress or snippet:webpage:domain:crawl:done.
The website identifier
The webpage domain snippet identifier
- POSThttps://api.crisp.chat/v1/website/website_id/snippets/webpages/domain/domain_snippet_id/refresh
- Tiersuser
(loading)
(loading)
Delete Webpage Domain
Deletes webpage domain for website. The domain might take some time to be deleted (in the background), since all linked pages must be removed and de-indexed as well.
The website identifier
The webpage domain snippet identifier
- DELETEhttps://api.crisp.chat/v1/website/website_id/snippets/webpages/domain/domain_snippet_id
- Tiersuser
(loading)
(loading)
List Webpage Domain Pages
Lists webpage domain pages for website.
The website identifier
The webpage domain snippet identifier
The page number (paging in answers list)
Page snippet identifier
Page root domain
Page URL (at root domain)
Page document title
Page content locale code (if any, ISO 639-1)
Page status
Page crawl state
Values
inactiverefreshingsuccessfailure
Timestamp since when the crawl status has been updated
Whether page snippet is disabled or not
- GEThttps://api.crisp.chat/v1/website/website_id/snippets/webpages/domain/domain_snippet_id/pages/list/page_number
- Tiersuser
(loading)
(loading)
Check If Webpage Domain Page Exists
Checks if webpage domain page exists for website.
The website identifier
The webpage domain snippet identifier
The webpage page snippet identifier
- HEADhttps://api.crisp.chat/v1/website/website_id/snippets/webpages/domain/domain_snippet_id/page/page_snippet_id
- Tiersuser
(loading)
(loading)
Update Webpage Domain Page
Updates webpage domain page for website.
The website identifier
The webpage domain snippet identifier
The webpage page snippet identifier
Whether webpage domain page is disabled or not
Page content locale code (ISO 639-1)
- PATCHhttps://api.crisp.chat/v1/website/website_id/snippets/webpages/domain/domain_snippet_id/page/page_snippet_id
- Tiersuser
(loading)
(loading)
Resolve Webpage Domain Page Content
Resolves webpage domain page content for website.
The website identifier
The webpage domain snippet identifier
The webpage page snippet identifier
Page document title
Page document content text (if any)
- GEThttps://api.crisp.chat/v1/website/website_id/snippets/webpages/domain/domain_snippet_id/page/page_snippet_id/content
- Tiersuser
(loading)
(loading)
List Overlay Searches
Lists overlay search snippets for website.
The website identifier
Overlay search snippet identifier
Search query
Search locale code (if any, ISO 639-1)
- GEThttps://api.crisp.chat/v1/website/website_id/snippets/overlay/searches
- Tiersuser
(loading)
(loading)
Add A New Overlay Search
Creates a new overlay search for website.
The website identifier
Search query
Search locale code (ISO 639-1)
- POSThttps://api.crisp.chat/v1/website/website_id/snippets/overlay/search
- Tiersuser
(loading)
(loading)
Check If Overlay Search Exists
Checks if overlay search exists for website.
The website identifier
The overlay search snippet identifier
- HEADhttps://api.crisp.chat/v1/website/website_id/snippets/overlay/search/search_snippet_id
- Tiersuser
(loading)
(loading)
Resolve Overlay Search
Resolves overlay search for website.
The website identifier
The overlay search snippet identifier
Overlay search snippet identifier
Search query
Search locale code (if any, ISO 639-1)
- GEThttps://api.crisp.chat/v1/website/website_id/snippets/overlay/search/search_snippet_id
- Tiersuser
(loading)
(loading)
Update Overlay Search
Updates overlay search for website.
The website identifier
The overlay search snippet identifier
Search query
Search locale code (ISO 639-1)
- PATCHhttps://api.crisp.chat/v1/website/website_id/snippets/overlay/search/search_snippet_id
- Tiersuser
(loading)
(loading)
Delete Overlay Search
Deletes overlay search for website.
The website identifier
The overlay search snippet identifier
- DELETEhttps://api.crisp.chat/v1/website/website_id/snippets/overlay/search/search_snippet_id
- Tiersuser
(loading)
(loading)
List Overlay Categories
Lists overlay category snippets for website.
The website identifier
Overlay category snippet identifier
Category name
Category color (if any)
Values
bluegreengreygrey-bluepinkpurpleredtealyellow
Category locale code (if any, ISO 639-1)
- GEThttps://api.crisp.chat/v1/website/website_id/snippets/overlay/categories
- Tiersuser
(loading)
(loading)
Add A New Overlay Category
Creates a new overlay category for website.
The website identifier
Category name
Category locale code (ISO 639-1)
- POSThttps://api.crisp.chat/v1/website/website_id/snippets/overlay/category
- Tiersuser
(loading)
(loading)
Check If Overlay Category Exists
Checks if overlay category exists for website.
The website identifier
The overlay category snippet identifier
- HEADhttps://api.crisp.chat/v1/website/website_id/snippets/overlay/category/category_snippet_id
- Tiersuser
(loading)
(loading)
Resolve Overlay Category
Resolves overlay category for website.
The website identifier
The overlay category snippet identifier
Overlay category snippet identifier
Category name
Category color (if any)
Values
bluegreengreygrey-bluepinkpurpleredtealyellow
Category locale code (if any, ISO 639-1)
- GEThttps://api.crisp.chat/v1/website/website_id/snippets/overlay/category/category_snippet_id
- Tiersuser
(loading)
(loading)
Update Overlay Category
Updates overlay category for website.
The website identifier
The overlay category snippet identifier
Category name
Category color
Values
bluegreengreygrey-bluepinkpurpleredtealyellow
Category locale code (ISO 639-1)
- PATCHhttps://api.crisp.chat/v1/website/website_id/snippets/overlay/category/category_snippet_id
- Tiersuser
(loading)
(loading)
Delete Overlay Category
Deletes overlay category for website.
The website identifier
The overlay category snippet identifier
- DELETEhttps://api.crisp.chat/v1/website/website_id/snippets/overlay/category/category_snippet_id
- Tiersuser
(loading)
(loading)
Status Pagein Website
Check If Status Page Exists
Checks if status page exists for website (ie. if it has been initialized).
The website identifier
- HEADhttps://api.crisp.chat/v1/website/website_id/status
- Tiersuser
(loading)
(loading)
Resolve Status Page
Resolves status page information for website.
The website identifier
Name of the status page
Public URL of the status page
- GEThttps://api.crisp.chat/v1/website/website_id/status
- Tiersuser
(loading)
(loading)
Initialize Status Page
Initializes a new status page for website.
The website identifier
Name of the status page
Basic domain of the status page (subdomain of default root domain)
- POSThttps://api.crisp.chat/v1/website/website_id/status
- Tiersuser
(loading)
(loading)
Delete Status Page
Deletes status page for website.
The website identifier
User password (used to double-authenticate deletion)
- DELETEhttps://api.crisp.chat/v1/website/website_id/status
- Tiersuser
(loading)
(loading)
List Status Page Services
Lists services for status page in website.
The website identifier
Page number for services paging
Search by service name
Service identifier
Name of the service
Service ordering weight
Service creation timestamp
Service update timestamp
- GEThttps://api.crisp.chat/v1/website/website_id/status/services/page_number
- Tiersuser
(loading)
(loading)
Add A New Status Page Service
Adds a new service for status page in website.
The website identifier
Name of the service
- POSThttps://api.crisp.chat/v1/website/website_id/status/service
- Tiersuser
(loading)
(loading)
Check If Status Page Service Exists
Checks if a service exists for status page in website.
The website identifier
The service identifier
- HEADhttps://api.crisp.chat/v1/website/website_id/status/service/service_id
- Tiersuser
(loading)
(loading)
Resolve Status Page Service
Resolves a service for status page in website.
The website identifier
The service identifier
Service identifier
Name of the service
Service ordering weight
Service creation timestamp
Service update timestamp
- GEThttps://api.crisp.chat/v1/website/website_id/status/service/service_id
- Tiersuser
(loading)
(loading)
Save Status Page Service
Saves a service for status page in website.
The website identifier
The service identifier
Name of the service
Service ordering weight
- PUThttps://api.crisp.chat/v1/website/website_id/status/service/service_id
- Tiersuser
(loading)
(loading)
Update Status Page Service
Updates a service for status page in website.
The website identifier
The service identifier
Name of the service
Service ordering weight
- PATCHhttps://api.crisp.chat/v1/website/website_id/status/service/service_id
- Tiersuser
(loading)
(loading)
Delete Status Page Service
Deletes a service for status page in website.
The website identifier
The service identifier
- DELETEhttps://api.crisp.chat/v1/website/website_id/status/service/service_id
- Tiersuser
(loading)
(loading)
List Status Page Service Nodes
Lists nodes in service for status page in website.
The website identifier
The service identifier
Page number for nodes paging
Search by node label
Node identifier
Label of the node
Monitoring mode for the node
Values
pollpushlocal
Node ordering weight
Node replicas (URLs for poll or local mode, either: icmp://, tcp://, http:// or https://)
HTTP probe configuration for node (if poll or local mode used, and replicas are: http:// or https://)
HTTP status to probe against
Consider replica healthy if HTTP response status is above (if any, eg. 200)
Consider replica healthy if HTTP response status is below (if any, eg. 400)
HTTP body to probe against
Consider replica healthy if HTTP response body contains (if any, eg. OK)
Node creation timestamp
Node update timestamp
- GEThttps://api.crisp.chat/v1/website/website_id/status/service/service_id/nodes/page_number
- Tiersuser
(loading)
(loading)
Add A New Status Page Service Node
Adds a new node in service for status page in website.
The website identifier
The service identifier
Label of the node
Monitoring mode for the node
Values
pollpushlocal
- POSThttps://api.crisp.chat/v1/website/website_id/status/service/service_id/node
- Tiersuser
(loading)
(loading)
Check If Status Page Service Node Exists
Checks if a node in service exists for status page in website.
The website identifier
The service identifier
The node identifier
- HEADhttps://api.crisp.chat/v1/website/website_id/status/service/service_id/node/node_id
- Tiersuser
(loading)
(loading)
Resolve Status Page Service Node
Resolves a node in service for status page in website.
The website identifier
The service identifier
The node identifier
Node identifier
Label of the node
Monitoring mode for the node
Values
pollpushlocal
Node ordering weight
Node replicas (URLs for poll or local mode, either: icmp://, tcp://, http:// or https://)
HTTP probe configuration for node (if poll or local mode used, and replicas are: http:// or https://)
HTTP status to probe against
Consider replica healthy if HTTP response status is above (if any, eg. 200)
Consider replica healthy if HTTP response status is below (if any, eg. 400)
HTTP body to probe against
Consider replica healthy if HTTP response body contains (if any, eg. OK)
Node creation timestamp
Node update timestamp
- GEThttps://api.crisp.chat/v1/website/website_id/status/service/service_id/node/node_id
- Tiersuser
(loading)
(loading)
Save Status Page Service Node
Saves a node in service for status page in website.
The website identifier
The service identifier
The node identifier
Label of the node
Node ordering weight
Node replicas (URLs for poll or local mode, either: icmp://, tcp://, http:// or https://)
HTTP probe configuration for node (if poll or local mode used, and replicas are: http:// or https://)
HTTP status to probe against
Consider replica healthy if HTTP response status is above (if any, eg. 200)
Consider replica healthy if HTTP response status is below (if any, eg. 400)
HTTP body to probe against
Consider replica healthy if HTTP response body contains (if any, eg. OK)
- PUThttps://api.crisp.chat/v1/website/website_id/status/service/service_id/node/node_id
- Tiersuser
(loading)
(loading)
Update Status Page Service Node
Updates a node in service for status page in website.
The website identifier
The service identifier
The node identifier
Label of the node
Node ordering weight
Node replicas (URLs for poll or local mode, either: icmp://, tcp://, http:// or https://)
HTTP probe configuration for node (if poll or local mode used, and replicas are: http:// or https://)
HTTP status to probe against
Consider replica healthy if HTTP response status is above (if any, eg. 200)
Consider replica healthy if HTTP response status is below (if any, eg. 400)
HTTP body to probe against
Consider replica healthy if HTTP response body contains (if any, eg. OK)
- PATCHhttps://api.crisp.chat/v1/website/website_id/status/service/service_id/node/node_id
- Tiersuser
(loading)
(loading)
Delete Status Page Service Node
Deletes a node in service for status page in website.
The website identifier
The service identifier
The node identifier
- DELETEhttps://api.crisp.chat/v1/website/website_id/status/service/service_id/node/node_id
- Tiersuser
(loading)
(loading)
List Status Page Service Node Replicas
Lists replicas health for node in service for status page in website.
The website identifier
The service identifier
The node identifier
Values
healthysickdead
- GEThttps://api.crisp.chat/v1/website/website_id/status/service/service_id/node/node_id/replicas
- Tiersuser
(loading)
(loading)
Flush Status Page Service Node Replicas
Flushes the list of replicas health for node in service for status page in website.
The website identifier
The service identifier
The node identifier
- DELETEhttps://api.crisp.chat/v1/website/website_id/status/service/service_id/node/node_id/replicas
- Tiersuser
(loading)
(loading)
Check If Status Page Announcement Exists
Checks if an announcement exists for status page in website.
The website identifier
- HEADhttps://api.crisp.chat/v1/website/website_id/status/announcement
- Tiersuser
(loading)
(loading)
Resolve Status Page Announcement
Resolves an announcement for status page in website.
The website identifier
Announcement title
Announcement message
Announcement creation timestamp
Announcement update timestamp
Announcement expiration date (can be blank)
- GEThttps://api.crisp.chat/v1/website/website_id/status/announcement
- Tiersuser
(loading)
(loading)
Save Status Page Announcement
Saves an announcement for status page in website.
The website identifier
Announcement title
Announcement message
Announcement expiration date (if any)
- PUThttps://api.crisp.chat/v1/website/website_id/status/announcement
- Tiersuser
(loading)
(loading)
Delete Status Page Announcement
Deletes an announcement for status page in website.
The website identifier
- DELETEhttps://api.crisp.chat/v1/website/website_id/status/announcement
- Tiersuser
(loading)
(loading)
Resolve Status Page Settings
Resolves settings for status page in website.
The website identifier
Name of the status page
Appearance configuration of the status page
Logos of the status page
Header logo URL (if any)
Footer logo URL (if any)
Banner image URL (if any)
Behavior configuration of the status page
Whether to show chatbox on status page or not
Whether to show a locale picker in header or not
Whether to show a link to Crisp in the footer of the status page or not
Whether to forbid search engine indexing of all status page pages
Include configuration for the status page
Raw HTML include (if any)
Metrics configuration of the status page
Poll metrics configuration
Number of times to retry if a poll fails
Delay for a replica to be considered dead (in seconds)
Delay for a replica to be considered sick (in seconds)
Push metrics configuration
Delay for a replica to be considered dead (in seconds)
System CPU load above which to consider a replica sick (from 0.01 to 10.00)
System RAM load above which to consider a replica sick (from 0.01 to 1.00)
Local metrics configuration
Number of times to retry if a local check fails
Delay for a replica to be considered dead (in seconds)
Delay for a replica to be considered sick (in seconds)
Notify configuration of the status page
Slack notification configuration (if any)
Slack Hook URL to send downtime Slack notifications to
Whether to mention all Slack channel members or not
Email notification configuration (if any)
Email address to send downtime email notifications to
App notification configuration (if any)
User identifiers to send downtime app push notifications to
Pushover notification configuration (if any)
Pushover application token to use for downtime notifications
Pushover users or groups to send downtime Pushover notifications to
- GEThttps://api.crisp.chat/v1/website/website_id/status/settings
- Tiersuser
(loading)
(loading)
Save Status Page Settings
Saves settings for status page in website.
The website identifier
Name of the status page
Appearance configuration of the status page
Logos of the status page
Header logo URL (if any)
Footer logo URL (if any)
Banner image URL (if any)
Behavior configuration of the status page
Whether to show chatbox on status page or not
Whether to show a locale picker in header or not
Whether to show a link to Crisp in the footer of the status page or not
Whether to forbid search engine indexing of all status page pages
Include configuration for the status page
Raw HTML include (if any)
Metrics configuration of the status page
Poll metrics configuration
Number of times to retry if a poll fails
Delay for a replica to be considered dead (in seconds)
Delay for a replica to be considered sick (in seconds)
Push metrics configuration
Delay for a replica to be considered dead (in seconds)
System CPU load above which to consider a replica sick (from 0.01 to 10.00)
System RAM load above which to consider a replica sick (from 0.01 to 1.00)
Local metrics configuration
Number of times to retry if a local check fails
Delay for a replica to be considered dead (in seconds)
Delay for a replica to be considered sick (in seconds)
Notify configuration of the status page
Slack notification configuration (if any)
Slack Hook URL to send downtime notifications to
Whether to mention all Slack channel members or not
Email notification configuration (if any)
Email address to send downtime notifications to
App notification configuration (if any)
User identifiers to send downtime app push notifications to
Pushover notification configuration (if any)
Pushover application token to use for downtime notifications
Pushover users or groups to send downtime Pushover notifications to
- PATCHhttps://api.crisp.chat/v1/website/website_id/status/settings
- Tiersuser
(loading)
(loading)
Resolve Status Page Domain
Resolves domain for status page in website.
The website identifier
Root domain for all status pages
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/status/domain
- Tiersuser
(loading)
(loading)
Request Status Page Domain Change
Requests a change in the domain used for status page. 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.watch)
Custom domain (fully qualified domain, can be blank)
- PATCHhttps://api.crisp.chat/v1/website/website_id/status/domain
- Tiersuser
(loading)
(loading)
Generate Status Page Domain Setup Flow
Retrieves the domain setup flow for status page. This will return the DNS records required for status page domain setup.
The website identifier
Custom domain to use for setup
Custom status page domain to return setup for
Setup flow for custom status page domain
DNS records for custom status page 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/status/domain/setup
- Tiersuser
(loading)
(loading)
Get Status Page Reporter Token
Resolves status page reporter token, that can be used in Crisp Status Report libraries.
The returned token is secret, and should not be shared. It provides only restricted access to Crisp status reporting systems.
The website identifier
Status page token
- GEThttps://api.crisp.chat/v1/website/website_id/status/reporter/token
- Tiersuser
(loading)
(loading)
Roll Status Page Reporter Token
Rolls status page reporter token. This generates a new token. Previous token is be invalidated.
If rolling a token, all Crisp Status Report libraries using the previous token will be unable to report their status. The previous token should be updated accordingly with the new token, where used.
The website identifier
- POSThttps://api.crisp.chat/v1/website/website_id/status/reporter/token
- Tiersuser
(loading)
(loading)
Connectin Website
Get Website Connect Endpoints
Resolves the website endpoints information.
The website identifier
Socket endpoints
RTM API WebSocket endpoint URL
Stream API WebSocket endpoint URL
- GEThttps://api.crisp.chat/v1/website/website_id/connect/endpoints
- Tiersuser
(loading)
(loading)
Singlein Limit
Get Limit Information
Resolves limit information.
The limit identifier
Limit identifier
Limit namespace
Values
bucket:urlcampaign:recipientoperator:invitesinbox:inboxestranslate:requeststranslate:characterspredict:requestspredict:wordsfilter:conversationsfilter:peoplepeople:profilesstatus:probes
Limit unit details
Chunk size per unit (ie. number of limit entries per unit)
Price per unit (in platform-wide currency)
- GEThttps://api.crisp.chat/v1/limit/limit_id
(loading)
(loading)
Listin Limit
List Limits
Lists available limits.
Limit identifier
Limit namespace
Values
bucket:urlcampaign:recipientoperator:invitesinbox:inboxestranslate:requeststranslate:characterspredict:requestspredict:wordsfilter:conversationsfilter:peoplepeople:profilesstatus:probes
Limit unit details
Chunk size per unit (ie. number of limit entries per unit)
Price per unit (in platform-wide currency)
- GEThttps://api.crisp.chat/v1/limits/list
(loading)
(loading)
Subscriptionin Limit
List All Active Limit Subscriptions
Lists all active limit subscriptions on all websites, linked to payment methods owned by the user, or from websites the user is member of.
Limit identifier
Limit namespace
Values
bucket:urlcampaign:recipientoperator:invitesinbox:inboxestranslate:requeststranslate:characterspredict:requestspredict:wordsfilter:conversationsfilter:peoplepeople:profilesstatus:probes
Limit price for all units (in platform-wide currency)
Whether the limit is active, or has been disabled (eg: due to failed renewal payment)
Limit units subscribed to
Number of baseline units (ie. units that are free of charge)
Number of additional units (ie. units that are paid for)
Website identifier on which limit is active
Card identifier which is used to pay the limit subscription
- GEThttps://api.crisp.chat/v1/limits/subscription
- Tiersuser
(loading)
(loading)
List Limit Subscriptions For A Website
Lists limit subscriptions for given website.
The website identifier
Limit identifier
Limit namespace
Values
bucket:urlcampaign:recipientoperator:invitesinbox:inboxestranslate:requeststranslate:characterspredict:requestspredict:wordsfilter:conversationsfilter:peoplepeople:profilesstatus:probes
Limit price for all units (in platform-wide currency)
Whether the limit is active, or has been disabled (eg: due to failed renewal payment)
Limit units subscribed to
Number of baseline units (ie. units that are free of charge)
Number of additional units (ie. units that are paid for)
Website identifier on which limit is active
- GEThttps://api.crisp.chat/v1/limits/subscription/website_id
- Tiersuser
(loading)
(loading)
Get Limit Subscription Details
Resolves details on a given subscription.
The website identifier
The limit identifier
Limit identifier
Limit namespace
Values
bucket:urlcampaign:recipientoperator:invitesinbox:inboxestranslate:requeststranslate:characterspredict:requestspredict:wordsfilter:conversationsfilter:peoplepeople:profilesstatus:probes
Limit price for all units (in platform-wide currency)
Whether the limit is active, or has been disabled (eg: due to failed renewal payment)
Limit units subscribed to
Number of baseline units (ie. units that are free of charge)
Number of additional units (ie. units that are paid for)
- GEThttps://api.crisp.chat/v1/limits/subscription/website_id/limit_id
- Tiersuser
(loading)
(loading)
Subscribe Website To Limit
Subscribes a given website to a given limit.
The website identifier
Limit identifier to subscribe to
Limit units to subscribe to
Additional number of units to subscribe to
- POSThttps://api.crisp.chat/v1/limits/subscription/website_id
- Tiersuser
(loading)
(loading)
Unsubscribe Limit From Website
Unsubscribes a given limit from a given website.
The website identifier
The limit identifier
- DELETEhttps://api.crisp.chat/v1/limits/subscription/website_id/limit_id
- Tiersuser
(loading)
(loading)
Billingin Limit
Resolve Total Billing Price For All Website Limits
Resolves total billing price for all subscribed website limits.
Total price billed for all subscribed limits
- GEThttps://api.crisp.chat/v1/limits/billing/all/price
- Tiersuser
(loading)
(loading)
Singlein Plugin
Get Plugin Information
Resolves plugin information.
The plugin identifier (also allowed: plugin URN)
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
- GEThttps://api.crisp.chat/v1/plugin/plugin_id
(loading)
(loading)
Get Plugin Details
Resolves plugin details.
The plugin identifier (also allowed: plugin URN)
Plugin description
Plugin scopes (if any)
Scope namespace
Values
bucket:urlwebsite:availabilitywebsite:operatorswebsite:settingswebsite:verifywebsite:visitorswebsite:conversation:initiatewebsite:conversation:sessionswebsite:conversation:suggestwebsite:conversation:messageswebsite:conversation:stateswebsite:conversation:participantswebsite:conversation:pageswebsite:conversation:eventswebsite:conversation:actionswebsite:conversation:browsingwebsite:conversation:callswebsite:conversation:reminderswebsite:conversation:routingwebsite:people:statisticswebsite:people:suggestwebsite:people:profileswebsite:people:conversationswebsite:people:eventswebsite:people:datawebsite:people:subscriptionswebsite:helpdesk:identitywebsite:helpdesk:localeswebsite:helpdesk:articleswebsite:helpdesk:categorieswebsite:helpdesk:feedbackswebsite:helpdesk:redirectionswebsite:helpdesk:settingswebsite:campaign:templatesplugin:subscription:bill
Scope permissions
Values
readwrite
Plugin author (can be blank)
Author first name
Author last name
Author business name (if any)
Author avatar (if any)
- GEThttps://api.crisp.chat/v1/plugin/plugin_id/details
(loading)
(loading)
List Plugin Features
Lists all plugin features.
The plugin identifier (also allowed: plugin URN)
The page number (paging in plugin feature list)
Title for the feature (can be blank)
Description for the feature (can be blank)
List of screenshot URLs for the feature (can be empty)
List of video URLs for the feature (can be empty)
- GEThttps://api.crisp.chat/v1/plugin/plugin_id/features/page_number
(loading)
(loading)
Listin Plugin
List All Plugins
Lists all available plugins on the marketplace.
The page number (paging in plugin list)
The plugin category to restrict results to
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
- GEThttps://api.crisp.chat/v1/plugins/list/all/page_number
(loading)
(loading)
Search Plugins
Searches for plugins in the marketplace, given a search term.
The page number (paging in plugin list)
Search query in all plugins
The plugin category to restrict results to
Whether to search in plugin names (1 or 0, defaults to 1)
Whether to search in plugin descriptions (1 or 0, defaults to 1)
Whether to search in plugin URNs (1 or 0, defaults to 1)
When to start relative to plugin creation date (date, ISO 8601)
When to end relative to plugin creation date (date, ISO 8601)
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
- GEThttps://api.crisp.chat/v1/plugins/list/search/page_number
(loading)
(loading)
Categoriesin Plugin
List All Plugins Categories
Lists all plugin categories that can be used to filter plugins.
The page number (paging in category list)
Plugin category identifier
Values
featureautomationcmscrmmarketingmessagingteamworkother
Number of plugins classified in this category
- GEThttps://api.crisp.chat/v1/plugins/categories/page_number
(loading)
(loading)
Widgetsin Plugin
List Plugin Widget Schemas For A Website
Lists plugin widget schemas for given website.
The website identifier
The page number (paging if many widgets)
Plugin identifier
Plugin subscription secret token (used for authentication purposes on external widgets)
Widget name (typically, the plugin name)
Widget icon (typically, the plugin icon)
Widget schema (JSONSchema)
- GEThttps://api.crisp.chat/v1/plugins/widgets/website_id/schemas/page_number
- Tiersuser
(loading)
(loading)
Billingin Plugin
Resolve Total Billing Price For All Website Plugins
Resolves total billing price for all subscribed website plugins.
Total price billed for all subscribed plugins
- GEThttps://api.crisp.chat/v1/plugins/billing/all/price
- Tiersuser
(loading)
(loading)
Resolve Usage Bills For All Website Plugins
Acquires all non-settled (ie. open) usage bills for all subscribed website plugins.
The page number (paging in list of bills)
Website identifier
Plugin identifier
Name of the billable item
Total units consumed
Price to charge per unit
- GEThttps://api.crisp.chat/v1/plugins/billing/all/bill/usage/page_number
- Tiersuser
(loading)
(loading)
Singlein Plan
Get Plan Information
Resolves plan information.
The plan identifier
Plan identifier
Plan name
Plan price (in platform-wide currency)
Number of days the plan can be tried for free upon first subscription
Datetime since when the plan is available
Plugin identifier
Plugin Uniform Resource Name
Plugin type
Values
internalexternal
Plugin name
Plugin category
Values
featureautomationcmscrmmarketingmessagingteamworkother
Plugin summary
Plugin 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
- GEThttps://api.crisp.chat/v1/plan/plan_id
(loading)
(loading)
Listin Plan
List Plans
Lists available plans.
Plan identifier
Plan name
Plan price (in platform-wide currency)
Number of days the plan can be tried for free upon first subscription
Datetime since when the plan is available
Plugin identifier
Plugin Uniform Resource Name
Plugin type
Values
internalexternal
Plugin name
Plugin category
Values
featureautomationcmscrmmarketingmessagingteamworkother
Plugin summary
Plugin 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
- GEThttps://api.crisp.chat/v1/plans/list
(loading)
(loading)
Subscriptionin Plan
List All Active Plan Subscriptions
Lists all active plan subscriptions on all websites, linked to payment methods owned by the user, or from websites the user is member of.
Plan identifier
Plan name
Plan price (in platform-wide currency)
Number of days the plan can be tried for free upon first subscription
Datetime since when the plan is available
Date when the plan trial ends, or ended (date after which the plan starts to be paid by the user)
Bill period (how often the subscription is paid for)
Values
monthlyyearly
Date until which the bill is valid for subscription (date at which the subscription will be renewed, thus paid again)
Whether the plan is active, or has been disabled (eg: due to failed renewal payment)
Whether the plan is in sandbox mode (sandbox mode is a restricted subscription mode used for development and staging websites)
Website identifier
Website name
Website domain
Website custom logo image URL (can be blank)
Whether a coupon was redeemed on this plan or not
Card identifier which is used to pay the plan subscription
Identity of the user responsible for the subscription (if any)
User identifier
User email
User first name
User last name
- GEThttps://api.crisp.chat/v1/plans/subscription
- Tiersuser
(loading)
(loading)
Get Plan Subscription For A Website
Resolves plan subscription for given website.
The website identifier
Plan identifier
Plan name
Plan price (in platform-wide currency)
Number of days the plan can be tried for free upon first subscription
Datetime since when the plan is available
Date when the plan trial ends, or ended (date after which the plan starts to be paid by the user)
Bill period (how often the subscription is paid for)
Values
monthlyyearly
Date until which the bill is valid for subscription (date at which the subscription will be renewed, thus paid again)
Whether the plan is active, or has been disabled (eg: due to failed renewal payment)
Whether the plan is in sandbox mode (sandbox mode is a restricted subscription mode used for development and staging websites)
Website identifier
Website name
Website domain
Website custom logo image URL (can be blank)
Whether a coupon was redeemed on this plan or not
Card identifier which is used to pay the plan subscription
Identity of the user responsible for the subscription (if any)
User identifier
User email
User first name
User last name
- GEThttps://api.crisp.chat/v1/plans/subscription/website_id
- Tiersuser
(loading)
(loading)
Subscribe Website To Plan
Subscribes a given website to a given plan.
The website identifier
Plan identifier to subscribe to
- POSThttps://api.crisp.chat/v1/plans/subscription/website_id
- Tiersuser
(loading)
(loading)
Unsubscribe Plan From Website
Unsubscribes a given plan from a given website.
The website identifier
- DELETEhttps://api.crisp.chat/v1/plans/subscription/website_id
- Tiersuser
(loading)
(loading)
Change Bill Period For Website Plan Subscription
Changes how often the website subscription is paid for. The payment method will be debited at selected interval for the due amount.
The website identifier
Bill period (how often the subscription is paid for)
Values
monthlyyearly
- PATCHhttps://api.crisp.chat/v1/plans/subscription/website_id/bill/period
- Tiersuser
(loading)
(loading)
Check Coupon Availability For Website Plan Subscription
Resolves a coupon for a website subscription. This helps check for coupon availability and returns information on the coupon.
The website identifier
Coupon code
Coupon code
Rebate percentage on plan price (or none)
Number of days of extended plan trial (or none)
Number of times the coupon can be redeemed (or none)
Coupon expiration date (or none)
- GEThttps://api.crisp.chat/v1/plans/subscription/website_id/coupon
- Tiersuser
(loading)
(loading)
Redeem Coupon For Website Plan Subscription
Redeems a coupon for a website subscription. This applies coupon rebates and upgrades immediately to the subscription.
The website identifier
Coupon code to redeem
- PATCHhttps://api.crisp.chat/v1/plans/subscription/website_id/coupon
- Tiersuser
(loading)
(loading)
Billingin Plan
Resolve Total Billing Price For All Website Plans
Resolves total billing price for all subscribed website plans. Note that a website price will not be accounted for if its subscription is still ongoing a trial period, or if it is not active anymore.
Total price billed for all subscribed plans
- GEThttps://api.crisp.chat/v1/plans/billing/all/price
- Tiersuser
(loading)
(loading)