---
canonical_url: "https://docs.composio.dev/toolkits/crisp"
markdown_url: "https://docs.composio.dev/toolkits/crisp.md"
product: "platform"
version: null
last_updated: null
---

# Crisp

Crisp is a customer messaging platform for managing conversations, contacts, operators, helpdesk content, campaigns, and workspace settings.

- **Category:** customer support
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 12
- **Triggers:** 0
- **Slug:** `CRISP`
- **Version:** 00000000_00

## Tools

### Assign Conversation

**Slug:** `CRISP_ASSIGN_CONVERSATION`

Assign a conversation to one operator or explicitly remove its current operator assignment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `silent` | boolean | No | If true, do not notify the newly assigned operator. |
| `operation` | string ("assign" | "unassign") | Yes | Whether to assign an operator or remove the current assignment. |
| `session_id` | string | Yes | Crisp session ID of the conversation. |
| `operator_id` | string | No | Operator user ID to assign. Required for assign and omitted for unassign. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Conversation

**Slug:** `CRISP_GET_CONVERSATION`

Get one conversation's status, assignment, inbox, visitor metadata, unread counts, and latest-message summary.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `session_id` | string | Yes | Crisp session ID of the conversation to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get People Profile

**Slug:** `CRISP_GET_PEOPLE_PROFILE`

Get one customer profile by its Crisp people ID or exact email address.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | No | Exact email address of the profile to retrieve. Supply exactly one of email or people_id. |
| `people_id` | string | No | Crisp people ID of the profile to retrieve. Supply exactly one of people_id or email. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Conversation Messages

**Slug:** `CRISP_LIST_CONVERSATION_MESSAGES`

Return a batch of messages from a conversation, optionally before, after, or around one millisecond timestamp.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `session_id` | string | Yes | Crisp session ID of the conversation. |
| `timestamp_after` | integer | No | Return a newer batch starting after this Unix timestamp in milliseconds. |
| `timestamp_around` | integer | No | Return a batch centered around this Unix timestamp in milliseconds. |
| `timestamp_before` | integer | No | Return an older batch ending before this Unix timestamp in milliseconds. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Conversations

**Slug:** `CRISP_LIST_CONVERSATIONS`

List or search workspace conversations with support-focused filters, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort_by` | string ("created_at" | "updated_at" | "waiting_since") | No | Optional ordering. waiting_since also excludes conversations that are not waiting. |
| `inbox_id` | string | No | Return only conversations in this inbox. Omit to search all inboxes. |
| `per_page` | integer | No | Conversations per page (20-50). |
| `resolution` | string ("resolved" | "not_resolved") | No | Filter by whether the conversation is resolved. |
| `page_number` | integer | No | Page to return, starting at 1. |
| `search_type` | string ("text" | "segment") | No | How Crisp should interpret search_query. Required when search_query is set; omit both for no search. |
| `unread_only` | boolean | No | Return only conversations with unread operator messages. |
| `search_query` | string | No | Text or segment name to search for, according to search_type. |
| `include_empty` | boolean | No | Include conversations that have no messages. |
| `updated_after` | string | No | Only conversations updated at or after this ISO 8601 timestamp. |
| `mentioned_only` | boolean | No | Return only conversations containing an operator mention. |
| `updated_before` | string | No | Only conversations updated at or before this ISO 8601 timestamp. |
| `unassigned_only` | boolean | No | Return only conversations with no assigned operator. Cannot be combined with assigned_operator_id. |
| `assigned_operator_id` | string | No | Return only conversations assigned to this operator user ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Inboxes

**Slug:** `CRISP_LIST_INBOXES`

List configured Crisp inboxes and their operator/team membership, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_number` | integer | No | Page to return, starting at 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Operators

**Slug:** `CRISP_LIST_OPERATORS`

List workspace operators and pending members with their IDs, roles, and current availability.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List People Profiles

**Slug:** `CRISP_LIST_PEOPLE_PROFILES`

List or search customer profiles by text, creation date, and sort order, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `per_page` | integer | No | Profiles per page (20-50). |
| `sort_field` | string | No | Crisp profile field to sort by, such as nickname or created_at. |
| `sort_order` | string ("ascending" | "descending") | No | Sort direction; omit to use Crisp's default direction. |
| `page_number` | integer | No | Page to return, starting at 1. |
| `search_text` | string | No | Quick-search text such as a name or email. |
| `created_after` | string | No | Only profiles created at or after this ISO 8601 timestamp. |
| `created_before` | string | No | Only profiles created at or before this ISO 8601 timestamp. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Move Conversation to Inbox

**Slug:** `CRISP_MOVE_CONVERSATION_TO_INBOX`

Move a conversation to a specific Crisp inbox, or remove its inbox categorization when inbox_id is null.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `inbox_id` | string | Yes | Destination inbox ID, or null to remove inbox categorization. |
| `session_id` | string | Yes | Crisp session ID of the conversation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send Conversation Message

**Slug:** `CRISP_SEND_CONVERSATION_MESSAGE`

Send a visitor-visible text reply to an existing Crisp conversation immediately; this external communication is irreversible.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `origin` | string | No | Delivery origin matching the conversation channel: chat, email, or a Crisp URN such as urn:crisp.im:slack:0. |
| `content` | string | Yes | Plain-text reply visible to the visitor. |
| `mentions` | array | No | Operator or team IDs to mention in the message. |
| `session_id` | string | Yes | Crisp session ID of the conversation to reply to. |
| `fingerprint` | integer | No | Optional unique message fingerprint for caller-managed duplicate prevention. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Conversation Meta

**Slug:** `CRISP_UPDATE_CONVERSATION_META`

Update support-relevant visitor details, subject, segments, or custom data on a conversation without replacing unspecified fields. Provide at least one field to update.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | No | Visitor email address. Omit to leave unchanged. |
| `phone` | string | No | Visitor phone number. Omit to leave unchanged. |
| `address` | string | No | Visitor postal address. Omit to leave unchanged. |
| `subject` | string | No | Conversation subject. Supply null only when explicitly clearing the subject. |
| `nickname` | string | No | Visitor display name. Omit to leave unchanged. |
| `segments` | array | No | Complete segment list to associate with the conversation. Omit to leave unchanged. |
| `session_id` | string | Yes | Crisp session ID of the conversation. |
| `custom_data` | object | No | Custom visitor data object to store as Crisp meta data. Omit to leave unchanged. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Conversation State

**Slug:** `CRISP_UPDATE_CONVERSATION_STATE`

Set a conversation to pending, unresolved, or resolved.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `state` | string ("pending" | "unresolved" | "resolved") | Yes | New support state for the conversation. |
| `session_id` | string | Yes | Crisp session ID of the conversation to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |
