https://github.com/crisp-im/node-crisp-api
:zap: Crisp API Node Wrapper
https://github.com/crisp-im/node-crisp-api
api chat integration livechat messenger rest websocket widget wrapper
Last synced: 5 months ago
JSON representation
:zap: Crisp API Node Wrapper
- Host: GitHub
- URL: https://github.com/crisp-im/node-crisp-api
- Owner: crisp-im
- License: mit
- Created: 2016-06-06T17:14:00.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2025-12-31T11:58:43.000Z (5 months ago)
- Last Synced: 2026-01-04T17:35:29.944Z (5 months ago)
- Topics: api, chat, integration, livechat, messenger, rest, websocket, widget, wrapper
- Language: TypeScript
- Homepage: https://docs.crisp.chat/guides/rest-api/
- Size: 778 KB
- Stars: 110
- Watchers: 3
- Forks: 41
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Crisp API Wrapper
[](https://github.com/crisp-im/node-crisp-api/actions/workflows/test.yml) [](https://github.com/crisp-im/node-crisp-api/actions/workflows/build.yml) [](https://www.npmjs.com/package/crisp-api) [](https://www.npmjs.com/package/crisp-api)
The Crisp API Node wrapper. Authenticate, send messages, fetch conversations, access your agent accounts from your JavaScript code.
Copyright 2026 Crisp IM SAS. See LICENSE for copying information.
* **📝 Implements**: [REST API Reference (V1)](https://docs.crisp.chat/references/rest-api/v1/) at revision: 09/01/2026
* **😘 Maintainers**: [@baptistejamin](https://github.com/baptistejamin), [@eliottvincent](https://github.com/eliottvincent), [@valeriansaliou](https://github.com/valeriansaliou)
## Installation
`npm install --save crisp-api`
## Authentication
To authenticate against the API, obtain your authentication token keypair by following the [REST API Authentication](https://docs.crisp.chat/guides/rest-api/authentication/) guide. You'll get a token keypair made of 2 values.
**Keep your token keypair values private, and store them safely for long-term use.**
Then, add authentication parameters to your `client` instance right after you create it:
```javascript
var Crisp = require("crisp-api");
var CrispClient = new Crisp();
// Authenticate to API with your plugin token (identifier, key)
// eg. CrispClient.authenticate("7c3ef21c-1e04-41ce-8c06-5605c346f73e", "cc29e1a5086e428fcc6a697d5837a66d82808e65c5cce006fbf2191ceea80a0a");
CrispClient.authenticateTier("plugin", identifier, key);
// Now, you can use authenticated API sections.
```
## Overview
You may follow the [REST API Quickstart](https://docs.crisp.chat/guides/rest-api/quickstart/) guide, which will get you running with the REST API in minutes.
```javascript
var Crisp = require("crisp-api");
var CrispClient = new Crisp();
CrispClient.authenticateTier("plugin", identifier, key);
CrispClient.website.listConversations(websiteID, 1)
.then(function(conversations) {
console.log("Listed conversations:", conversations);
})
.catch(function(error) {
console.error("Error listing conversations:", error);
});
```
## Examples
### Create your own bot!
```javascript
var Crisp = require("crisp-api");
var CrispClient = new Crisp();
CrispClient.authenticateTier("plugin", identifier, key);
// Notice: make sure to authenticate before listening for an event
CrispClient.on("message:send", function(message) {
CrispClient.website.sendMessageInConversation(
message.website_id, message.session_id,
{
type : "text",
content : "I'm a bot",
from : "operator", // or user
origin : "chat"
}
)
.then(function(message) {
console.log("Message sent:", message);
})
.catch(function(error) {
console.error("Error sending message:", error);
});
})
.then(function() {
console.error("Requested to listen to sent messages");
})
.catch(function(error) {
console.error("Failed listening to sent messages:", error);
});
```
## Resource Methods
All the available Crisp API resources are fully implemented. **Programmatic methods names are named after their label name in the [REST API Reference](https://docs.crisp.chat/references/rest-api/v1/)**.
All methods that you will most likely need when building a Crisp integration are prefixed with a star symbol (⭐).
**⚠️ Note that, depending on your authentication token tier, which is either `user` or `plugin`, you may not be allowed to use all methods from the library. When in doubt, refer to the library method descriptions below. Most likely, you are using a `plugin` token.**
---
- Website Conversations
- Website Conversation
- Website People
- Website Helpdesk
- Website Operator
- Website Availability
- Website Analytics
- Website Batch
- Website Inbox
- Website Verify
- Website Campaigns
- Website Campaign
- Session Events
- Message Events
- People Events
- Campaign Events
- Browsing Events
- Call Events
- Widget Events
- Status Events
- Website Events
- Bucket Events
- Media Events
- Email Events
- Plugin Events
---
### Website
* #### **Website Conversations**
* **⭐ List Conversations** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-conversations)
* `CrispClient.website.listConversations(websiteID, pageNumber, options)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var pageNumber = 1;
var options = {
per_page: 50
}
CrispClient.website.listConversations(websiteID, pageNumber, options);
```
* **List Suggested Conversation Segments** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-suggested-conversation-segments)
* `CrispClient.website.listSuggestedConversationSegments(websiteID, pageNumber)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var pageNumber = 1;
CrispClient.website.listSuggestedConversationSegments(websiteID, pageNumber);
```
* **Delete Suggested Conversation Segment** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#delete-suggested-conversation-segment)
* `CrispClient.website.deleteSuggestedConversationSegment(websiteID, segment)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var segment = "bug";
CrispClient.website.deleteSuggestedConversationSegment(websiteID, segment);
```
* **List Suggested Conversation Data Keys** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-suggested-conversation-data-keys)
* `CrispClient.website.listSuggestedConversationDataKeys(websiteID, pageNumber)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var pageNumber = 1;
CrispClient.website.listSuggestedConversationDataKeys(websiteID, pageNumber);
```
* **Delete Suggested Conversation Data Key** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#delete-suggested-conversation-data-key)
* `CrispClient.website.deleteSuggestedConversationDataKey(websiteID, key)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var key = "price";
CrispClient.website.deleteSuggestedConversationDataKey(websiteID, key);
```
* **List Spam Conversations** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-spam-conversations)
* `CrispClient.website.listSpamConversations(websiteID, pageNumber)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var pageNumber = 1;
CrispClient.website.listSpamConversations(websiteID, pageNumber);
```
* **Resolve Spam Conversation Content** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#resolve-spam-conversation-content)
* `CrispClient.website.resolveSpamConversationContent(websiteID, spamID)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var spamID = "b45e7d75-61ab-416c-858b-1919b5fcfd10";
CrispClient.website.resolveSpamConversationContent(websiteID, spamID);
```
* **Submit Spam Conversation Decision** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#submit-spam-conversation-decision)
* `CrispClient.website.submitSpamConversationDecision(websiteID, spamID, action)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var spamID = "b45e7d75-61ab-416c-858b-1919b5fcfd10";
var action = "reject";
CrispClient.website.submitSpamConversationDecision(websiteID, spamID, action);
```
* #### **Website Conversation**
* **⭐ Create A New Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#create-a-new-conversation)
* `CrispClient.website.createNewConversation(websiteID)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
CrispClient.website.createNewConversation(websiteID);
```
* **Check If Conversation Exists** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#check-if-conversation-exists)
* `CrispClient.website.checkConversationExists(websiteID, sessionID)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
CrispClient.website.checkConversationExists(websiteID, sessionID);
```
* **⭐ Get A Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-a-conversation)
* `CrispClient.website.getConversation(websiteID, sessionID)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
CrispClient.website.getConversation(websiteID, sessionID);
```
* **Remove A Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#remove-a-conversation)
* `CrispClient.website.removeConversation(websiteID, sessionID)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
CrispClient.website.removeConversation(websiteID, sessionID);
```
* **Initiate A Conversation With Existing Session** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#initiate-a-conversation-with-existing-session)
* `CrispClient.website.initiateConversationWithExistingSession(websiteID, sessionID)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
CrispClient.website.initiateConversationWithExistingSession(websiteID, sessionID);
```
* **⭐ Get Messages In Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-messages-in-conversation)
* `CrispClient.website.getMessagesInConversation(websiteID, sessionID, timestampBefore)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
var timestampBefore = 1641206011000;
CrispClient.website.getMessagesInConversation(websiteID, sessionID, timestampBefore);
```
* **⭐ Send A Message In Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#send-a-message-in-conversation)
* `CrispClient.website.sendMessageInConversation(websiteID, sessionID, message)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
var message = {
"type": "text",
"from": "operator",
"origin": "chat",
"content": "Hey there! Need help?"
};
CrispClient.website.sendMessageInConversation(websiteID, sessionID, message);
```
* **Get A Message In Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-a-message-in-conversation)
* `CrispClient.website.getMessageInConversation(websiteID, sessionID, fingerprint)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
var fingerprint = 524653764345;
CrispClient.website.getMessageInConversation(websiteID, sessionID, fingerprint);
```
* **Update A Message In Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-a-message-in-conversation)
* `CrispClient.website.updateMessageInConversation(websiteID, sessionID, fingerprint, content)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
var fingerprint = 524653764345;
var content = "Hey there! Need help?";
CrispClient.website.updateMessageInConversation(websiteID, sessionID, fingerprint, content);
```
* **Remove A Message In Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#remove-a-message-in-conversation)
* `CrispClient.website.removeMessageInConversation(websiteID, sessionID, fingerprint)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
var fingerprint = 524653764345;
CrispClient.website.removeMessageInConversation(websiteID, sessionID, fingerprint);
```
* **Compose A Message In Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#compose-a-message-in-conversation)
* `CrispClient.website.composeMessageInConversation(websiteID, sessionID, compose)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
var compose = {
"type": "start",
"from": "operator"
};
CrispClient.website.composeMessageInConversation(websiteID, sessionID, compose);
```
* **⭐ Mark Messages As Read In Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#mark-messages-as-read-in-conversation)
* `CrispClient.website.markMessagesReadInConversation(websiteID, sessionID, read)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
var read = {
"from": "operator",
"origin": "urn:crisp.im:slack:0",
"fingerprints": [
"5719231201"
]
};
CrispClient.website.markMessagesReadInConversation(websiteID, sessionID, read);
```
* **Mark Conversation As Unread** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#mark-conversation-as-unread)
* `CrispClient.website.markConversationAsUnread(websiteID, sessionID, unread)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
var unread = {
"from": "operator"
};
CrispClient.website.markConversationAsUnread(websiteID, sessionID, unread);
```
* **⭐ Mark Messages As Delivered In Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#mark-messages-as-delivered-in-conversation)
* `CrispClient.website.markMessagesDeliveredInConversation(websiteID, sessionID, delivered)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
var delivered = {
"from": "operator",
"origin": "urn:crisp.im:slack:0",
"fingerprints": [
"5719231201"
]
};
CrispClient.website.markMessagesDeliveredInConversation(websiteID, sessionID, delivered);
```
* **Update Conversation Open State** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-conversation-open-state)
* `CrispClient.website.updateConversationOpenState(websiteID, sessionID, opened)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
var opened = true;
CrispClient.website.updateConversationOpenState(websiteID, sessionID, opened);
```
* **⭐ Get Conversation Routing Assign** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-conversation-routing-assign)
* `CrispClient.website.getConversationRoutingAssign(websiteID, sessionID)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
CrispClient.website.getConversationRoutingAssign(websiteID, sessionID);
```
* **⭐ Assign Conversation Routing** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#assign-conversation-routing)
* `CrispClient.website.assignConversationRouting(websiteID, sessionID, assign)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
var assign = {
"assigned": {
"user_id": "a4c32c68-be91-4e29-8a05-976e93abbe3f"
}
};
CrispClient.website.assignConversationRouting(websiteID, sessionID, assign);
```
* **Update Conversation Inbox** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-conversation-inbox)
* `CrispClient.website.updateConversationInbox(websiteID, sessionID, inboxID)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
var inboxID = "bf6935c9-43b3-4f8e-87ea-175c1e1ed1a9";
CrispClient.website.updateConversationInbox(websiteID, sessionID, inboxID);
```
* **⭐ Get Conversation Metas** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-conversation-metas)
* `CrispClient.website.getConversationMetas(websiteID, sessionID)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
CrispClient.website.getConversationMetas(websiteID, sessionID);
```
* **⭐ Update Conversation Metas** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-conversation-metas)
* `CrispClient.website.updateConversationMetas(websiteID, sessionID, metas)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
var metas = {
"nickname": "John Doe",
"email": "john.doe@acme-inc.com",
"segments": [
"happy",
"customer",
"love"
],
"data": {
"type": "customer",
"signup": "finished"
}
};
CrispClient.website.updateConversationMetas(websiteID, sessionID, metas);
```
* **Get An Original Message In Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-an-original-message-in-conversation)
* `CrispClient.website.getOriginalMessageInConversation(websiteID, sessionID, originalID)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
var originalID = "2325a3c0-9b47-4fc6-b00e-111b752e44cd";
CrispClient.website.getOriginalMessageInConversation(websiteID, sessionID, originalID);
```
* **List Conversation Pages** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-conversation-pages)
* `CrispClient.website.listConversationPages(websiteID, sessionID, pageNumber)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
var pageNumber = 1;
CrispClient.website.listConversationPages(websiteID, sessionID, pageNumber);
```
* **List Conversation Events** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-conversation-events)
* `CrispClient.website.listConversationEvents(websiteID, sessionID, pageNumber)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
var pageNumber = 1;
CrispClient.website.listConversationEvents(websiteID, sessionID, pageNumber);
```
* **List Conversation Files** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-conversation-files)
* `CrispClient.website.listConversationFiles(websiteID, sessionID, pageNumber)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
var pageNumber = 1;
CrispClient.website.listConversationFiles(websiteID, sessionID, pageNumber);
```
* **Get Conversation State** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-conversation-state)
* `CrispClient.website.getConversationState(websiteID, sessionID)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
CrispClient.website.getConversationState(websiteID, sessionID);
```
* **⭐ Change Conversation State** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#change-conversation-state)
* `CrispClient.website.changeConversationState(websiteID, sessionID, state)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
var state = "unresolved";
CrispClient.website.changeConversationState(websiteID, sessionID, state);
```
* **Get Conversation Participants** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-conversation-participants)
* `CrispClient.website.getConversationParticipants(websiteID, sessionID)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
CrispClient.website.getConversationParticipants(websiteID, sessionID);
```
* **Save Conversation Participants** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#save-conversation-participants)
* `CrispClient.website.saveConversationParticipants(websiteID, sessionID, participants)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
var participants = {
"participants": [
{
"type": "email",
"target": "jane.doe@acme-inc.com"
}
]
};
CrispClient.website.saveConversationParticipants(websiteID, sessionID, participants);
```
* **Get Block Status For Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-block-status-for-conversation)
* `CrispClient.website.getBlockStatusForConversation(websiteID, sessionID)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
CrispClient.website.getBlockStatusForConversation(websiteID, sessionID);
```
* **Block Incoming Messages For Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#block-incoming-messages-for-conversation)
* `CrispClient.website.blockIncomingMessagesForConversation(websiteID, sessionID, blocked)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
var blocked = true;
CrispClient.website.blockIncomingMessagesForConversation(websiteID, sessionID, blocked);
```
* **Get Verify Status For Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-verify-status-for-conversation)
* `CrispClient.website.getVerifyStatusForConversation(websiteID, sessionID)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
CrispClient.website.getVerifyStatusForConversation(websiteID, sessionID);
```
* **Update Verify Status For Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-verify-status-for-conversation)
* `CrispClient.website.updateVerifyStatusForConversation(websiteID, sessionID, verified)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
var verified = true;
CrispClient.website.updateVerifyStatusForConversation(websiteID, sessionID, verified);
```
* **Request Identity Verification For Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#request-identity-verification-for-conversation)
* `CrispClient.website.requestIdentityVerificationForConversation(websiteID, sessionID, verification)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
var verification = {
"identity": "email"
};
CrispClient.website.requestIdentityVerificationForConversation(websiteID, sessionID, verification);
```
* **Redeem Identity Verification Link For Conversation**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#redeem-identity-verification-link-for-conversation)
* `CrispClient.website.redeemIdentityVerificationLinkForConversation(websiteID, sessionID, identity, token)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
var verification = {
"identity": "email",
"token": "709691"
};
CrispClient.website.redeemIdentityVerificationLinkForConversation(websiteID, sessionID, verification);
```
* **Request Email Transcript For Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#request-email-transcript-for-conversation)
* `CrispClient.website.requestEmailTranscriptForConversation(websiteID, sessionID, to, email)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
var email = {
"to": "operator",
"email": "valerian@crisp.chat"
};
CrispClient.website.requestEmailTranscriptForConversation(websiteID, sessionID, to, email);
```
* **Request Chatbox Binding Purge For Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#request-chatbox-binding-purge-for-conversation)
* `CrispClient.website.requestChatboxBindingPurgeForConversation(websiteID, sessionID)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
CrispClient.website.requestChatboxBindingPurgeForConversation(websiteID, sessionID);
```
* **Request User Feedback For Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#request-user-feedback-for-conversation)
* `CrispClient.website.requestUserFeedbackForConversation(websiteID, sessionID)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
CrispClient.website.requestUserFeedbackForConversation(websiteID, sessionID);
```
* **List Browsing Sessions For Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-browsing-sessions-for-conversation)
* `CrispClient.website.listBrowsingSessionsForConversation(websiteID, sessionID)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
CrispClient.website.listBrowsingSessionsForConversation(websiteID, sessionID);
```
* **Initiate Browsing Session For Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#initiate-browsing-session-for-conversation)
* `CrispClient.website.initiateBrowsingSessionForConversation(websiteID, sessionID)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
CrispClient.website.initiateBrowsingSessionForConversation(websiteID, sessionID);
```
* **Send Action To An Existing Browsing Session** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#send-action-to-an-existing-browsing-session)
* `CrispClient.website.sendActionToExistingBrowsingSession(websiteID, sessionID, browsingID, action)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
var browsingID = "browsing_05a9392d-ff3f-45e7-b021-1179c45668fa";
var action = "start";
CrispClient.website.sendActionToExistingBrowsingSession(websiteID, sessionID, browsingID, action);
```
* **Assist Existing Browsing Session** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#assist-an-existing-browsing-session)
* `CrispClient.website.assistExistingBrowsingSession(websiteID, sessionID, browsingID, assist)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
var browsingID = "browsing_05a9392d-ff3f-45e7-b021-1179c45668fa";
var assist = {
"action": "mouse",
"mouse": {
"x": 0,
"y": 784
}
};
CrispClient.website.assistExistingBrowsingSession(websiteID, sessionID, browsingID, assist);
```
* **Initiate New Call Session For Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#initiate-new-call-session-for-conversation)
* `CrispClient.website.initiateNewCallSessionForConversation(websiteID, sessionID, mode)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
var mode = "audio";
CrispClient.website.initiateNewCallSessionForConversation(websiteID, sessionID, mode);
```
* **Get Ongoing Call Session For Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-ongoing-call-session-for-conversation)
* `CrispClient.website.getOngoingCallSessionForConversation(websiteID, sessionID)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
CrispClient.website.getOngoingCallSessionForConversation(websiteID, sessionID);
```
* **Abort Ongoing Call Session For Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#abort-ongoing-call-session-for-conversation)
* `CrispClient.website.abortOngoingCallSessionForConversation(websiteID, sessionID, callID)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
var callID = "call_35a0c062-72fa-4095-a2a0-f9911d47ee56";
CrispClient.website.abortOngoingCallSessionForConversation(websiteID, sessionID, callID);
```
* **Transmit Signaling On Ongoing Call Session** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#transmit-signaling-on-ongoing-call-session)
* `CrispClient.website.transmitSignalingOnOngoingCallSession(websiteID, sessionID, callID, payload)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
var callID = "call_35a0c062-72fa-4095-a2a0-f9911d47ee56";
var payload = {
"type": "sdp",
"payload": {}
};
CrispClient.website.transmitSignalingOnOngoingCallSession(websiteID, sessionID, callID, payload);
```
* **Deliver Widget Button Action For Conversation** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#deliver-widget-button-action-for-conversation)
* `CrispClient.website.deliverWidgetButtonActionForConversation(websiteID, sessionID, pluginID, sectionID, itemID, data, value)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
var sectionID = "8f8d3041-6698-43b8-a559-ae93211e6292";
var itemID = "7631d7d8-4fe7-4ef8-9a36-31183dcd4785";
var value = {
"section_id": "payments",
"item_id": "refund_on_stripe",
"data": {
"invoice": "D-1929-X"
}
};
CrispClient.website.deliverWidgetButtonActionForConversation(websiteID, sessionID, pluginID, sectionID, itemID, data, value);
```
* **Deliver Widget Data Fetch Action For Conversation** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#deliver-widget-data-action-for-conversation)
* `CrispClient.website.deliverWidgetDataFetchActionForConversation(websiteID, sessionID, pluginID, sectionID, itemID, data)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
var sectionID = "8f8d3041-6698-43b8-a559-ae93211e6292";
var itemID = "7631d7d8-4fe7-4ef8-9a36-31183dcd4785";
var data = {
"section_id": "payments",
"item_id": "unpaid_balance",
"action": "fetch",
"data": {}
};
CrispClient.website.deliverWidgetDataFetchActionForConversation(websiteID, sessionID, pluginID, sectionID, itemID, data);
```
* **Deliver Widget Data Edit Action For Conversation** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#deliver-widget-data-action-for-conversation)
* `CrispClient.website.deliverWidgetDataEditActionForConversation(websiteID, sessionID, pluginID, sectionID, itemID, value)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb";
var sectionID = "8f8d3041-6698-43b8-a559-ae93211e6292";
var itemID = "7631d7d8-4fe7-4ef8-9a36-31183dcd4785";
var data = {
"section_id": "payments",
"item_id": "unpaid_balance",
"action": "fetch",
"data": {}
};
CrispClient.website.deliverWidgetDataFetchActionForConversation(websiteID, sessionID, pluginID, sectionID, itemID, data);
```
* **Schedule A Reminder For Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#schedule-a-reminder-for-conversation)
* `CrispClient.website.scheduleReminderForConversation(websiteID, sessionID, date, note)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
var note = {
"date": "2018-05-29T09:00:00Z",
"note": "Call this customer."
};
CrispClient.website.scheduleReminderForConversation(websiteID, sessionID, date, note);
```
* **Report Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#report-conversation)
* `CrispClient.website.reportConversation(websiteID, sessionID, flag)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
var flag = "spam";
CrispClient.website.reportConversation(websiteID, sessionID, flag);
```
* ### **Website People** _(these are your end-users)_
* **Get People Statistics** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-people-statistics)
* `CrispClient.website.getPeopleStatistics(websiteID)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
CrispClient.website.getPeopleStatistics(websiteID);
```
* **List Suggested People Segments** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-suggested-people-segments)
* `CrispClient.website.listSuggestedPeopleSegments(websiteID, pageNumber)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var pageNumber = 1;
CrispClient.website.listSuggestedPeopleSegments(websiteID, pageNumber);
```
* **Delete Suggested People Segment** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#delete-suggested-people-segment)
* `CrispClient.website.deleteSuggestedPeopleSegment(websiteID, segment)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var segment = "poweruser";
CrispClient.website.deleteSuggestedPeopleSegment(websiteID, segment);
```
* **List Suggested People Data Keys** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-suggested-people-data-keys)
* `CrispClient.website.listSuggestedPeopleDataKeys(websiteID, pageNumber)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var pageNumber = 1;
CrispClient.website.listSuggestedPeopleDataKeys(websiteID, pageNumber);
```
* **Delete Suggested People Data Key** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#delete-suggested-people-data-key)
* `CrispClient.website.deleteSuggestedPeopleDataKey(websiteID, key)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var key = "price";
CrispClient.website.deleteSuggestedPeopleDataKey(websiteID, key);
```
* **List Suggested People Events** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-suggested-people-events)
* `CrispClient.website.listSuggestedPeopleEvents(websiteID, pageNumber)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var pageNumber = 1;
CrispClient.website.listSuggestedPeopleEvents(websiteID, pageNumber);
```
* **Delete Suggested People Event** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#delete-suggested-people-event)
* `CrispClient.website.deleteSuggestedPeopleEvent(websiteID, text)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var text = "Removed item from basket";
CrispClient.website.deleteSuggestedPeopleEvent(websiteID, text);
```
* **⭐ List People Profiles** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-people-profiles)
* `CrispClient.website.listPeopleProfiles(websiteID, pageNumber, searchField, searchOrder, searchOperator, searchFilter, searchText)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var pageNumber = 1;
CrispClient.website.listPeopleProfiles(websiteID, pageNumber, searchField, searchOrder, searchOperator, searchFilter, searchText);
```
* **⭐ Add New People Profile** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#add-new-people-profile)
* `CrispClient.website.addNewPeopleProfile(websiteID, peopleProfile)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var peopleProfile = {
"email": "valerian@crisp.chat",
"person": {
"nickname": "Valerian Saliou"
}
};
CrispClient.website.addNewPeopleProfile(websiteID, peopleProfile);
```
* **⭐ Check If People Profile Exists** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#check-if-people-profile-exists)
* `CrispClient.website.checkPeopleProfileExists(websiteID, peopleID)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
CrispClient.website.checkPeopleProfileExists(websiteID, peopleID);
```
* **⭐ Get People Profile** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-people-profile)
* `CrispClient.website.getPeopleProfile(websiteID, peopleID)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
CrispClient.website.getPeopleProfile(websiteID, peopleID);
```
* **⭐ Save People Profile** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#save-people-profile)
* `CrispClient.website.savePeopleProfile(websiteID, peopleID, peopleProfile)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
var peopleProfile = {
"email": "valerian@crisp.chat",
"person": {
"nickname": "Valerian Saliou"
}
};
CrispClient.website.savePeopleProfile(websiteID, peopleID, peopleProfile);
```
* **⭐ Update People Profile** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-people-profile)
* `CrispClient.website.updatePeopleProfile(websiteID, peopleID, peopleProfile)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
var peopleProfile = {
"email": "valerian@crisp.chat",
"person": {
"nickname": "Valerian Saliou"
}
};
CrispClient.website.updatePeopleProfile(websiteID, peopleID, peopleProfile);
```
* **⭐ Remove People Profile** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#remove-people-profile)
* `CrispClient.website.removePeopleProfile(websiteID, peopleID)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
CrispClient.website.removePeopleProfile(websiteID, peopleID);
```
* **List People Conversations** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-people-conversations)
* `CrispClient.website.listPeopleConversations(websiteID, peopleID, pageNumber)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
var pageNumber = 1;
CrispClient.website.listPeopleConversations(websiteID, peopleID, pageNumber);
```
* **List People Campaigns** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-people-campaigns)
* `CrispClient.website.listPeopleCampaigns(websiteID, peopleID, pageNumber)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
var pageNumber = 1;
CrispClient.website.listPeopleCampaigns(websiteID, peopleID, pageNumber);
```
* **Add A People Event** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#add-a-people-event)
* `CrispClient.website.addPeopleEvent(websiteID, peopleID, peopleEvent)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
var peopleEvent = {
"text": "Added item to basket",
"data": {
"price": 10.99,
"currency": "USD"
},
"color": "red"
};
CrispClient.website.addPeopleEvent(websiteID, peopleID, peopleEvent);
```
* **List People Events** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-people-events)
* `CrispClient.website.listPeopleEvents(websiteID, peopleID, pageNumber)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
var pageNumber = 1;
CrispClient.website.listPeopleEvents(websiteID, peopleID, pageNumber);
```
* **Get People Data** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-people-data)
* `CrispClient.website.getPeopleData(websiteID, peopleID)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
CrispClient.website.getPeopleData(websiteID, peopleID);
```
* **Save People Data** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#save-people-data)
* `CrispClient.website.savePeopleData(websiteID, peopleID, peopleData)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
var peopleData = {
"data": {
"type": "customer",
"signup": "finished"
}
};
CrispClient.website.savePeopleData(websiteID, peopleID, peopleData);
```
* **Update People Data** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-people-data)
* `CrispClient.website.updatePeopleData(websiteID, peopleID, peopleData)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
var peopleData = {
"data": {
"signup": "finished"
}
};
CrispClient.website.updatePeopleData(websiteID, peopleID, peopleData);
```
* **Get People Subscription Status** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-people-subscription-status)
* `CrispClient.website.getPeopleSubscriptionStatus(websiteID, peopleID)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
CrispClient.website.getPeopleSubscriptionStatus(websiteID, peopleID);
```
* **Update People Subscription Status** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-people-subscription-status)
* `CrispClient.website.updatePeopleSubscriptionStatus(websiteID, peopleID, peopleSubscription)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50";
var peopleSubscription = {
"email": true
};
CrispClient.website.updatePeopleSubscriptionStatus(websiteID, peopleID, peopleSubscription);
```
* **Export People Profiles** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#export-people-profiles)
* `CrispClient.website.exportPeopleProfiles(websiteID)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
CrispClient.website.exportPeopleProfiles(websiteID);
```
* **Import People Profiles** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#import-people-profiles)
* `CrispClient.website.importPeopleProfiles(websiteID, profileImportSetup)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var profileImportSetup = {
"url": "https://storage.crisp.chat/users/processing/import/aa0b64dd-9fb4-4db9-80d6-5a49eb84087b/19d956c7-0294-45ad-89e1-58ce45e7008f.csv",
"mapping": [
{
"column": 1,
"field": "email"
},
{
"column": 2,
"field": "person.nickname"
}
],
"options": {
"column_separator": ";",
"skip_header": true
}
};
CrispClient.website.importPeopleProfiles(websiteID, profileImportSetup);
```
_👉 Notice: The `peopleID` argument can be an email or the `peopleID`._
* #### **Website Helpdesk**
* **Check If Helpdesk Exists** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#check-if-helpdesk-exists)
* `CrispClient.website.checkHelpdeskExists(websiteID)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
CrispClient.website.checkHelpdeskExists(websiteID);
```
* **Resolve Helpdesk** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#resolve-helpdesk)
* `CrispClient.website.resolveHelpdesk(websiteID)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
CrispClient.website.resolveHelpdesk(websiteID);
```
* **Initialize Helpdesk** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#initialize-helpdesk)
* `CrispClient.website.initializeHelpdesk(websiteID, name, domainBasic)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var name = "Valerian Helpdesk";
var domainBasic = "valerian";
CrispClient.website.initializeHelpdesk(websiteID, name, domainBasic);
```
* **Delete Helpdesk** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#delete-helpdesk)
* `CrispClient.website.deleteHelpdesk(websiteID, verify)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var verify = {
"method": "password",
"secret": "MySuperSecurePassword";
};
CrispClient.website.deleteHelpdesk(websiteID, verify);
```
* **List Helpdesk Locales** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-helpdesk-locales)
* `CrispClient.website.listHelpdeskLocales(websiteID, pageNumber, options={})`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var pageNumber = 1;
CrispClient.website.listHelpdeskLocales(websiteID, pageNumber, {
order_visits : "1"
});
```
* **Add Helpdesk Locale** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#add-helpdesk-locale)
* `CrispClient.website.addHelpdeskLocale(websiteID, locale)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
CrispClient.website.addHelpdeskLocale(websiteID, locale);
```
* **Check If Helpdesk Locale Exists** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#check-if-helpdesk-locale-exists)
* `CrispClient.website.checkHelpdeskLocaleExists(websiteID, locale)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
CrispClient.website.checkHelpdeskLocaleExists(websiteID, locale);
```
* **Resolve Helpdesk Locale** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#resolve-helpdesk-locale)
* `CrispClient.website.resolveHelpdeskLocale(websiteID, locale)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
CrispClient.website.resolveHelpdeskLocale(websiteID, locale);
```
* **Delete Helpdesk Locale** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#delete-helpdesk-locale)
* `CrispClient.website.deleteHelpdeskLocale(websiteID, locale)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
CrispClient.website.deleteHelpdeskLocale(websiteID, locale);
```
* **List Helpdesk Locale Articles** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-helpdesk-locale-articles)
* `CrispClient.website.listHelpdeskLocaleArticles(websiteID, locale, pageNumber)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var pageNumber = 1;
CrispClient.website.listHelpdeskLocaleArticles(websiteID, locale, pageNumber);
```
* **Add A New Helpdesk Locale Article** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#add-a-new-helpdesk-locale-article)
* `CrispClient.website.addNewHelpdeskLocaleArticle(websiteID, locale, title)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var title = "How to use $crisp JavaScript SDK?";
CrispClient.website.addNewHelpdeskLocaleArticle(websiteID, locale, title);
```
* **Check If Helpdesk Locale Article Exists** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#check-if-helpdesk-locale-article-exists)
* `CrispClient.website.checkHelpdeskLocaleArticleExists(websiteID, locale, articleId)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6";
CrispClient.website.checkHelpdeskLocaleArticleExists(websiteID, locale, articleId);
```
* **Resolve Helpdesk Locale Article** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#resolve-helpdesk-locale-article)
* `CrispClient.website.resolveHelpdeskLocaleArticle(websiteID, locale, articleId)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6";
CrispClient.website.resolveHelpdeskLocaleArticle(websiteID, locale, articleId);
```
* **Save Helpdesk Locale Article** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#save-helpdesk-locale-article)
* `CrispClient.website.saveHelpdeskLocaleArticle(websiteID, locale, articleId, article)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6";
var article = {
"title": "How to use $crisp JavaScript SDK?",
"description": null,
"content": "Crisp lets you create your customized chatbox easily. **It's easy to setup**.",
"featured": false,
"order": 1
};
CrispClient.website.saveHelpdeskLocaleArticle(websiteID, locale, articleId, article);
```
* **Update Helpdesk Locale Article** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-helpdesk-locale-article)
* `CrispClient.website.updateHelpdeskLocaleArticle(websiteID, locale, articleId, article)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6";
var article = {
"content": "Crisp lets you create your customized chatbox easily. **It's easy to setup**."
};
CrispClient.website.updateHelpdeskLocaleArticle(websiteID, locale, articleId, article);
```
* **Delete Helpdesk Locale Article** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#delete-helpdesk-locale-article)
* `CrispClient.website.deleteHelpdeskLocaleArticle(websiteID, locale, articleId)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6";
CrispClient.website.deleteHelpdeskLocaleArticle(websiteID, locale, articleId);
```
* **Resolve Helpdesk Locale Article Page** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#resolve-helpdesk-locale-article-page)
* `CrispClient.website.resolveHelpdeskLocaleArticlePage(websiteID, locale, articleId)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6";
CrispClient.website.resolveHelpdeskLocaleArticlePage(websiteID, locale, articleId);
```
* **Resolve Helpdesk Locale Article Category** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#resolve-helpdesk-locale-article-category)
* `CrispClient.website.resolveHelpdeskLocaleArticleCategory(websiteID, locale, articleId)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6";
CrispClient.website.resolveHelpdeskLocaleArticleCategory(websiteID, locale, articleId);
```
* **Update Helpdesk Locale Article Category** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-helpdesk-locale-article-category)
* `CrispClient.website.updateHelpdeskLocaleArticleCategory(websiteID, locale, articleId, categoryId, sectionId)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6";
var categoryId = "00d344a3-8948-45b5-9bc4-82ec249fcd44";
CrispClient.website.updateHelpdeskLocaleArticleCategory(websiteID, locale, articleId, categoryId);
```
* **List Helpdesk Locale Article Alternates** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-helpdesk-locale-article-alternates)
* `CrispClient.website.listHelpdeskLocaleArticleAlternates(websiteID, locale, articleId)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6";
CrispClient.website.listHelpdeskLocaleArticleAlternates(websiteID, locale, articleId);
```
* **Check If Helpdesk Locale Article Alternate Exists** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#check-if-helpdesk-locale-article-alternate-exists)
* `CrispClient.website.checkHelpdeskLocaleArticleAlternateExists(websiteID, locale, articleId, localeLinked)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6";
var localeLinked = "fr";
CrispClient.website.checkHelpdeskLocaleArticleAlternateExists(websiteID, locale, articleId, localeLinked);
```
* **Resolve Helpdesk Locale Article Alternate** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#resolve-helpdesk-locale-article-alternate)
* `CrispClient.website.resolveHelpdeskLocaleArticleAlternate(websiteID, locale, articleId, localeLinked)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6";
var localeLinked = "fr";
CrispClient.website.resolveHelpdeskLocaleArticleAlternate(websiteID, locale, articleId, localeLinked);
```
* **Save Helpdesk Locale Article Alternate** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#save-helpdesk-locale-article-alternate)
* `CrispClient.website.saveHelpdeskLocaleArticleAlternate(websiteID, locale, articleId, localeLinked, articleIdLinked)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6";
var localeLinked = "fr";
var articleIdLinked = "9dc0e823-56b0-43ca-9ca3-47e25a8eb543";
CrispClient.website.saveHelpdeskLocaleArticleAlternate(websiteID, locale, articleId, localeLinked, articleIdLinked);
```
* **Delete Helpdesk Locale Article Alternate** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#delete-helpdesk-locale-article-alternate)
* `CrispClient.website.deleteHelpdeskLocaleArticleAlternate(websiteID, locale, articleId, localeLinked)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6";
var localeLinked = "fr";
CrispClient.website.deleteHelpdeskLocaleArticleAlternate(websiteID, locale, articleId, localeLinked);
```
* **Publish Helpdesk Locale Article** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#publish-helpdesk-locale-article)
* `CrispClient.website.publishHelpdeskLocaleArticle(websiteID, locale, articleId)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6";
CrispClient.website.publishHelpdeskLocaleArticle(websiteID, locale, articleId);
```
* **Unpublish Helpdesk Locale Article** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#unpublish-helpdesk-locale-article)
* `CrispClient.website.unpublishHelpdeskLocaleArticle(websiteID, locale, articleId)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6";
CrispClient.website.unpublishHelpdeskLocaleArticle(websiteID, locale, articleId);
```
* **List Helpdesk Locale Categories** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-helpdesk-locale-categories)
* `CrispClient.website.listHelpdeskLocaleCategories(websiteID, locale, pageNumber)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var pageNumber = 1;
CrispClient.website.listHelpdeskLocaleCategories(websiteID, locale, pageNumber);
```
* **Add Helpdesk Locale Category** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#add-helpdesk-locale-category)
* `CrispClient.website.addHelpdeskLocaleCategory(websiteID, locale, name)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var name = "Chatbox";
CrispClient.website.addHelpdeskLocaleCategory(websiteID, locale, name);
```
* **Check If Helpdesk Locale Category Exists** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#check-if-helpdesk-locale-category-exists)
* `CrispClient.website.checkHelpdeskLocaleCategoryExists(websiteID, locale, categoryId)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var categoryId = "33bc73b7-b7db-40a9-80fc-fcba8ebd1067";
CrispClient.website.checkHelpdeskLocaleCategoryExists(websiteID, locale, categoryId);
```
* **Resolve Helpdesk Locale Category** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#resolve-helpdesk-locale-category)
* `CrispClient.website.resolveHelpdeskLocaleCategory(websiteID, locale, categoryId)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var categoryId = "33bc73b7-b7db-40a9-80fc-fcba8ebd1067";
CrispClient.website.resolveHelpdeskLocaleCategory(websiteID, locale, categoryId);
```
* **Save Helpdesk Locale Category** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#save-helpdesk-locale-category)
* `CrispClient.website.saveHelpdeskLocaleCategory(websiteID, locale, categoryId, category)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var categoryId = "33bc73b7-b7db-40a9-80fc-fcba8ebd1067";
var category = {
"name": "Chatbox",
"description": "Help on how to setup and use the Crisp chatbox.",
"color": "#377FEA",
"image": null,
"order": 1
};
CrispClient.website.saveHelpdeskLocaleCategory(websiteID, locale, categoryId, category);
```
* **Update Helpdesk Locale Category** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-helpdesk-locale-category)
* `CrispClient.website.updateHelpdeskLocaleCategory(websiteID, locale, categoryId, category)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var categoryId = "33bc73b7-b7db-40a9-80fc-fcba8ebd1067";
var category = {
"color": "#377FEA"
};
CrispClient.website.updateHelpdeskLocaleCategory(websiteID, locale, categoryId, category);
```
* **Delete Helpdesk Locale Category** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#delete-helpdesk-locale-category)
* `CrispClient.website.deleteHelpdeskLocaleCategory(websiteID, locale, categoryId)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var categoryId = "33bc73b7-b7db-40a9-80fc-fcba8ebd1067";
CrispClient.website.deleteHelpdeskLocaleCategory(websiteID, locale, categoryId);
```
* **List Helpdesk Locale Sections** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-helpdesk-locale-sections)
* `CrispClient.website.listHelpdeskLocaleSections(websiteID, locale, categoryId, pageNumber)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var categoryId = "33bc73b7-b7db-40a9-80fc-fcba8ebd1067";
var pageNumber = 1;
CrispClient.website.listHelpdeskLocaleSections(websiteID, locale, categoryId, pageNumber);
```
* **Add Helpdesk Locale Section** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#add-helpdesk-locale-section)
* `CrispClient.website.addHelpdeskLocaleSection(websiteID, locale, categoryId, name)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var categoryId = "33bc73b7-b7db-40a9-80fc-fcba8ebd1067";
var name = "Integrate with our SDKs";
CrispClient.website.addHelpdeskLocaleSection(websiteID, locale, categoryId, name);
```
* **Check If Helpdesk Locale Section Exists** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#check-if-helpdesk-locale-section-exists)
* `CrispClient.website.checkHelpdeskLocaleSectionExists(websiteID, locale, categoryId, sectionId)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var categoryId = "33bc73b7-b7db-40a9-80fc-fcba8ebd1067";
var sectionID = "14886b8c-faf6-4967-af0a-2d90b3419263";
CrispClient.website.checkHelpdeskLocaleSectionExists(websiteID, locale, categoryId, sectionId);
```
* **Resolve Helpdesk Locale Section** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#resolve-helpdesk-locale-section)
* `CrispClient.website.resolveHelpdeskLocaleSection(websiteID, locale, categoryId, sectionId)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var categoryId = "33bc73b7-b7db-40a9-80fc-fcba8ebd1067";
var sectionID = "14886b8c-faf6-4967-af0a-2d90b3419263";
CrispClient.website.resolveHelpdeskLocaleSection(websiteID, locale, categoryId, sectionId);
```
* **Save Helpdesk Locale Section** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#save-helpdesk-locale-section)
* `CrispClient.website.saveHelpdeskLocaleSection(websiteID, locale, categoryId, sectionId, section)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var categoryId = "33bc73b7-b7db-40a9-80fc-fcba8ebd1067";
var sectionID = "14886b8c-faf6-4967-af0a-2d90b3419263";
var section = {
"name": "Integrate with our SDKs",
"order": 1
};
CrispClient.website.saveHelpdeskLocaleSection(websiteID, locale, categoryId, sectionId, section);
```
* **Update Helpdesk Locale Section** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-helpdesk-locale-section)
* `CrispClient.website.updateHelpdeskLocaleSection(websiteID, locale, categoryId, sectionId, section)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var categoryId = "33bc73b7-b7db-40a9-80fc-fcba8ebd1067";
var sectionID = "14886b8c-faf6-4967-af0a-2d90b3419263";
var section = {
"name": "Integrate with our SDKs",
"order": 1
};
CrispClient.website.updateHelpdeskLocaleSection(websiteID, locale, categoryId, sectionId, section);
```
* **Delete Helpdesk Locale Section** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#delete-helpdesk-locale-section)
* `CrispClient.website.deleteHelpdeskLocaleSection(websiteID, locale, categoryId, sectionId)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var categoryId = "33bc73b7-b7db-40a9-80fc-fcba8ebd1067";
var sectionID = "14886b8c-faf6-4967-af0a-2d90b3419263";
CrispClient.website.deleteHelpdeskLocaleSection(websiteID, locale, categoryId, sectionId);
```
* **Map Helpdesk Locale Feedback Ratings** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#map-helpdesk-locale-feedback-ratings)
* `CrispClient.website.mapHelpdeskLocaleFeedbackRatings(websiteID, locale, filterDateStart, filterDateEnd)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
CrispClient.website.mapHelpdeskLocaleFeedbackRatings(websiteID, locale);
```
* **List Helpdesk Locale Feedbacks** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-helpdesk-locale-feedbacks)
* `CrispClient.website.listHelpdeskLocaleFeedbacks(websiteID, locale, pageNumber, filterDateStart, filterDateEnd)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var pageNumber = 1;
CrispClient.website.listHelpdeskLocaleFeedbacks(websiteID, locale, pageNumber);
```
* **Import External Helpdesk To Locale** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#import-external-helpdesk-to-locale)
* `CrispClient.website.importExternalHelpdeskToLocale(websiteID, locale, helpdeskUrl)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
var helpdeskUrl = "https://docs.acme.com/";
CrispClient.website.importExternalHelpdeskToLocale(websiteID, locale, helpdeskUrl);
```
* **Export Helpdesk Locale Articles** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#export-helpdesk-locale-articles)
* `CrispClient.website.exportHelpdeskLocaleArticles(websiteID, locale)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var locale = "en";
CrispClient.website.exportHelpdeskLocaleArticles(websiteID, locale);
```
* **List Helpdesk Redirections** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-helpdesk-redirections)
* `CrispClient.website.listHelpdeskRedirections(websiteID, pageNumber)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var pageNumber = 1;
CrispClient.website.listHelpdeskRedirections(websiteID, pageNumber);
```
* **Add Helpdesk Redirection** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#add-helpdesk-redirection)
* `CrispClient.website.addHelpdeskRedirection(websiteID, redirectionPath, redirectionTarget)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var redirectionPath = "/en/article/how-can-i-automatically-set-custom-user-data/";
var redirectionTarget = "/en/article/how-can-i-automatically-set-custom-user-data-1xh7pqk/";
CrispClient.website.addHelpdeskRedirection(websiteID, redirectionPath, redirectionTarget);
```
* **Check If Helpdesk Redirection Exists** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#check-if-helpdesk-redirection-exists)
* `CrispClient.website.checkHelpdeskRedirectionExists(websiteID, redirectionId)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var redirectionId = "7ebf2e39-1780-45c9-aa81-fa7a7078cb25";
CrispClient.website.checkHelpdeskRedirectionExists(websiteID, redirectionId);
```
* **Resolve Helpdesk Redirection** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#resolve-helpdesk-redirection)
* `CrispClient.website.resolveHelpdeskRedirection(websiteID, redirectionId)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var redirectionId = "7ebf2e39-1780-45c9-aa81-fa7a7078cb25";
CrispClient.website.resolveHelpdeskRedirection(websiteID, redirectionId);
```
* **Delete Helpdesk Redirection** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#delete-helpdesk-redirection)
* `CrispClient.website.deleteHelpdeskRedirection(websiteID, redirectionId)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var redirectionId = "7ebf2e39-1780-45c9-aa81-fa7a7078cb25";
CrispClient.website.deleteHelpdeskRedirection(websiteID, redirectionId);
```
* **Resolve Helpdesk Settings** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#resolve-helpdesk-settings)
* `CrispClient.website.resolveHelpdeskSettings(websiteID)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
CrispClient.website.resolveHelpdeskSettings(websiteID);
```
* **Save Helpdesk Settings** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#save-helpdesk-settings)
* `CrispClient.website.saveHelpdeskSettings(websiteID, settings)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var settings = {
"name": "Valerian Helpdesk",
"appearance": {
"logos": {
"header": null,
"footer": null
},
"banner": null
},
"behavior": {
"frequently_read": true,
"show_category_images": true,
"show_chatbox": true,
"ask_feedback": false,
"locale_picker": false,
"refer_link": true,
"forbid_indexing": false,
"status_health_dead": true
},
"include": {
"html": null
},
"access": {
"password": null
}
};
CrispClient.website.saveHelpdeskSettings(websiteID, settings);
```
* **Resolve Helpdesk Domain** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#resolve-helpdesk-domain)
* `CrispClient.website.resolveHelpdeskDomain(websiteID)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
CrispClient.website.resolveHelpdeskDomain(websiteID);
```
* **Request Helpdesk Domain Change** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#request-helpdesk-domain-change)
* `CrispClient.website.requestHelpdeskDomainChange(websiteID, basic, custom)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var basic = "valerian";
var custom = "help.valeriansaliou.name";
CrispClient.website.requestHelpdeskDomainChange(websiteID, basic, custom);
```
* **Generate Helpdesk Domain Setup Flow** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#generate-helpdesk-domain-setup-flow)
* `CrispClient.website.generateHelpdeskDomainSetupFlow(websiteID, custom)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var custom = "help.valeriansaliou.name";
CrispClient.website.generateHelpdeskDomainSetupFlow(websiteID, custom);
```
* #### **Website Base**
* **Check If Website Exists** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#check-if-website-exists)
* `CrispClient.website.checkWebsiteExists(domain)`
*
See Example
```javascript
CrispClient.website.checkWebsiteExists(domain);
```
* **Create Website** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#create-website)
* `CrispClient.website.createWebsite(websiteData)`
*
See Example
```javascript
CrispClient.website.createWebsite(websiteData);
```
* **Get A Website** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-a-website)
* `CrispClient.website.getWebsite(websiteID)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
CrispClient.website.getWebsite(websiteID);
```
* **Delete A Website** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#delete-a-website)
* `CrispClient.website.deleteWebsite(websiteID, verify)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var verify = {
"method": "password",
"secret": "MySuperSecurePassword";
};
CrispClient.website.deleteWebsite(websiteID, verify);
```
* **Abort Website Deletion** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#abort-website-deletion)
* `CrispClient.website.abortWebsiteDeletion(websiteID)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
CrispClient.website.abortWebsiteDeletion(websiteID);
```
* #### **Website Settings**
* **Get Website Settings** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-website-settings)
* `CrispClient.website.getWebsiteSettings(websiteID)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
CrispClient.website.getWebsiteSettings(websiteID);
```
* **Update Website Settings** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#update-website-settings)
* `CrispClient.website.updateWebsiteSettings(websiteID, settings)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var settings = {
"name": "Crisp",
"domain": "crisp.chat",
"logo": "https://storage.crisp.chat/users/avatar/website/8c842203-7ed8-4e29-a608-7cf78a7d2fcc/b6c2948d-b061-405e-91a9-2fdf855d1cc0.png",
"audit": {
"log": true
},
"contact": {
"email": "contact@crisp.chat",
"phone": "+33757905447"
},
"inbox": {
"lock_removal": false,
"force_operator_token": false,
"locale": ""
},
"emails": {
"rating": true,
"transcript": true,
"enrich": true,
"junk_filter": true
},
"chatbox": {
"tile": "default",
"wait_game": false,
"website_logo": true,
"last_operator_face": false,
"ongoing_operator_face": true,
"activity_metrics": true,
"operator_privacy": false,
"visitor_privacy": false,
"availability_tooltip": true,
"hide_vacation": false,
"hide_on_away": false,
"hide_on_mobile": false,
"position_reverse": false,
"email_visitors": false,
"phone_visitors": false,
"force_identify": false,
"ignore_privacy": false,
"visitor_compose": false,
"file_transfer": true,
"audio_record": true,
"overlay_search": true,
"overlay_mode": false,
"helpdesk_link": true,
"helpdesk_only": false,
"helpdesk_navigate": "deep",
"status_health_dead": true,
"check_domain": false,
"color_theme": "blue",
"color_mode": "auto",
"layout_theme": "default",
"text_theme": "default",
"welcome_message": "default",
"locale": "en",
"allowed_pages": [],
"blocked_pages": [
"status/*/",
"docs.crisp.chat/*",
"crisp.chat/terms/",
"https://crisp.chat/privacy/"
],
"blocked_countries": [
"IT"
],
"blocked_locales": [
"fa",
"he"
],
"blocked_ips": [
"8.8.8.8",
"2001:0db8:85a3:0000:0000:8a2e:0370:7334",
"192.168.1.1/24"
]
}
};
CrispClient.website.updateWebsiteSettings(websiteID, settings);
```
* #### **Website Operator**
* **List Website Operators** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-website-operators)
* `CrispClient.website.listWebsiteOperators(websiteID)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
CrispClient.website.listWebsiteOperators(websiteID);
```
* **List Last Active Website Operators** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-last-active-website-operators)
* `CrispClient.website.listLastActiveWebsiteOperators(websiteID)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
CrispClient.website.listLastActiveWebsiteOperators(websiteID);
```
* **Flush Last Active Website Operators** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#flush-last-active-website-operators)
* `CrispClient.website.flushLastActiveWebsiteOperators(websiteID)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
CrispClient.website.flushLastActiveWebsiteOperators(websiteID);
```
* **Send Email To Website Operators** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#send-email-to-website-operators)
* `CrispClient.website.sendEmailToWebsiteOperators(websiteID, emailData)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var emailData = {
"recipient": "owners",
"subject": "Plugin limits reached",
"message": "Hi, you've reached the Slack plugin limits. Please contact our support team."
};
CrispClient.website.sendEmailToWebsiteOperators(websiteID, emailData);
```
* **Get A Website Operator** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#get-a-website-operator)
* `CrispClient.website.getWebsiteOperator(websiteID, userID)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var userID = "a4c32c68-be91-4e29-8a05-976e93abbe3f";
CrispClient.website.getWebsiteOperator(websiteID, userID);
```
* **Invite A Website Operator** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#invite-a-website-operator)
* `CrispClient.website.inviteWebsiteOperator(websiteID, email, role, verify)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var email = "julien@crisp.chat";
var role = "member";
var verify = {
"method": "password",
"secret": "MySuperSecurePassword";
};
CrispClient.website.inviteWebsiteOperator(websiteID, email, role, verify);
```
* **Change Operator Membership** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#change-operator-membership)
* `CrispClient.website.changeOperatorMembership(websiteID, userID, role, title)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var userID = "a4c32c68-be91-4e29-8a05-976e93abbe3f";
var title = {
"role": "owner",
"title": "CTO"
};
CrispClient.website.changeOperatorMembership(websiteID, userID, role, title);
```
* **Unlink Operator From Website** [`user`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#unlink-operator-from-website)
* `CrispClient.website.unlinkOperatorFromWebsite(websiteID, userID)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var userID = "a4c32c68-be91-4e29-8a05-976e93abbe3f";
CrispClient.website.unlinkOperatorFromWebsite(websiteID, userID);
```
* #### **Website Visitors**
* **Count Visitors** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#count-visitors)
* `CrispClient.website.countVisitors(websiteID)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
CrispClient.website.countVisitors(websiteID);
```
* **List Visitors** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#list-visitors)
* `CrispClient.website.listVisitors(websiteID, pageNumber)`
*
See Example
```javascript
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
var pageNumber = 1;
CrispClient.website.listVisitors(websiteID, pageNumber);
```
* **Pinpoint Visitors On A Map** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#pinpoint-visitors-on-a-map)
* `CrispClient.website.pinpointVisitorsOnMap(websiteID, centerLongitude, centerLatitude, centerRadius)`
*
See Example
```javascript
var websi