REST API Reference (V1)

Updated on October 14, 2021

The Crisp REST API offers access and control over all Crisp data (conversations, contacts and more).

While integrating the REST API, you may be interested in the following guides:

Basein Website

Check If Website Exists

HEAD
/website{?domain}

Checks if given website exists (by domain).

URI Parameters
domain
stringRequired

The website domain to check against

  • HEADhttps://api.crisp.chat/v1/website
  • Tiersuserplugin
HTTP
Code
(loading)
Result
(loading)

Create Website

POST
/website

Creates a new website.

Data Structure
name
stringRequired

Website name

domain
stringRequired

Website domain

  • POSThttps://api.crisp.chat/v1/website
  • Tiersuser
HTTP
Code
(loading)
Result
(loading)

Get A Website

GET
/website/{website_id}

Resolves an existing website information.

URI Parameters
website_id
stringRequired

The website identifier

Data Structure
error
boolean
reason
string
data
object
website_id
string

Website identifier

name
string

Website name

domain
string

Website domain

logo
string

Website custom logo image URL (can be blank)

  • GEThttps://api.crisp.chat/v1/website/website_id
  • Tiersuserplugin
HTTP
Code
(loading)
Result
(loading)

Delete A Website

DELETE
/website/{website_id}

Deletes an existing website.

URI Parameters
website_id
stringRequired

The website identifier

Data Structure
verify
stringRequired

User password (used to double-authenticate deletion)

  • DELETEhttps://api.crisp.chat/v1/website/website_id
  • Tiersuser
HTTP
Code
(loading)
Result
(loading)

Conversationsin Website

List Conversations

GET
/website/{website_id}/conversations/{page_number}{?search_query}{&search_type}{&search_operator}{&include_empty}{&filter_unread}{&filter_resolved}{&filter_not_resolved}{&filter_mention}{&filter_assigned}{&filter_unassigned}{&filter_date_start}{&filter_date_end}{&order_date_created}{&order_date_updated}

Lists conversations for website.

URI Parameters
website_id
stringRequired

The website identifier

page_number
stringOptional

Page number for conversations paging

search_query
stringOptional

Search query in all conversations (text if type is text or segment, filter if type is filter)

search_type
stringOptional

Search type (either text, segment or filter)

search_operator
stringOptional

Search operator if search type is filter (or or and respectful to boolean algebra, defaults to and if not set)

include_empty
stringOptional

Whether to include conversations without any message (1 or 0, defaults to 0)

filter_unread
stringOptional

Whether to return only conversations with unread messages (1 or 0, defaults to 0)

filter_resolved
stringOptional

Whether to return only conversations that are resolved (1 or 0, defaults to 0)

filter_not_resolved
stringOptional

Whether to return only conversations that are not resolved (1 or 0, defaults to 0)

filter_mention
stringOptional

Whether to return only conversations where user is mentioned (1 or 0, defaults to 0)

filter_assigned
stringOptional

Whether to return only conversations that are assigned to user identifier

filter_unassigned
stringOptional

Whether to return only conversations that are not assigned to any user (1 or 0, defaults to 0)

filter_date_start
stringOptional

When to start relative to conversation creation date (date, ISO 8601, eg. 2018-03-01T17:00:00.000Z)

filter_date_end
stringOptional

When to end relative to conversation creation date (date, ISO 8601, eg. 2018-04-01T10:30:00.000Z)

order_date_created
stringOptional

Whether to order conversations by date created instead of default order (1 or 0, defaults to 0)

order_date_updated
stringOptional

Whether to order conversations by date updated instead of default order (1 or 0, defaults to 0)

Data Structure
error
boolean
reason
string
data
array[object]
session_id
string

Session identifier

website_id
string

Website identifier

people_id
string

People identifier

state
enum[string]

Conversation state

Values

  • pending
  • unresolved
  • resolved
status
enum[number]

Conversation status (an alias of state; useful for sorting conversations)

Values

  • 1
  • 2
is_verified
boolean

Whether session is verified or not (user email ownership is authenticated)

is_blocked
boolean

Whether session is blocked or not (block messages from visitor)

availability
enum[string]

Visitor availability

Values

  • online
  • offline
active
object

User activity statistics (eg. moved their mouse if reported from the Crisp chatbox)

now
boolean

Whether user is considered active right now or not

last
number

Timestamp at which the user was last active

last_message
string

Last message excerpt

participants
array[object]

External participants for this conversation

type
enum[string]

External participant type

Values

  • email
target
string

External participant target (ie. email address, identifier, etc.)

mentions
array[string]

Mentioned user identifiers (from conversation messages)

created_at
number

Conversation creation timestamp

updated_at
number

Conversation update timestamp

compose
object

Compose states

operator
object

Compose state for operator

type
enum[string]

Compose state type

Values

  • start
  • stop
excerpt
string

Message excerpt for compose state

timestamp
number

Timestamp for compose state

user
object

Compose user information

user_id
string

Compose user identifier

nickname
string

Compose user nickname

avatar
string

Compose user avatar

visitor
object

Compose state for visitor

type
enum[string]

Compose state type

Values

  • start
  • stop
excerpt
string

Message excerpt for compose state

timestamp
number

Timestamp for compose state

unread
object

Unread messages counters

operator
number

Unread messages counter for operator

visitor
number

Unread messages counter for visitor

assigned
object

Assigned operator (if any)

user_id
string

Operator user identifier

meta
object

Meta-data for conversation

nickname
string

Visitor nickname

email
string

Visitor email

phone
string

Visitor phone

address
string

Visitor address

ip
string

Visitor IP address

data
object

Visitor data

avatar
string

Visitor avatar

device
object

Device information

capabilities
array[enum[string]]

Visitor device capabilities

Values

  • browsing
  • call
geolocation
object

Geolocation information for visitor device

country
string

Country code

region
string

Region code

city
string

City name

coordinates
object

Location coordinates

latitude
number

Latitude coordinate

longitude
number

Longitude coordinate

system
object

Visitor device system information

os
object

Operating system information

version
string

OS version

name
string

OS name

engine
object

Rendering engine information

version
string

Engine version

name
string

Engine name

browser
object

Browser information

major
string

Browser major version (eg: version 8.1 has a major of 8)

version
string

Browser version

name
string

Browser name

useragent
string

Visitor user agent

timezone
number

Visitor device timezone offset (UTC)

locales
array[string]

Visitor device locales

segments
array[string]

Segments attributed to conversation

  • GEThttps://api.crisp.chat/v1/website/website_id/conversations/page_number
  • Tiersuserplugin
  • Scopeswebsite:conversation:sessions
HTTP
Code
(loading)
Result
(loading)

List Suggested Conversation Segments

GET
/website/{website_id}/conversations/suggest/segments/{page_number}

Lists suggested conversation segments for website.

URI Parameters
website_id
stringRequired

The website identifier

page_number
stringOptional

The page number (paging in segment list)

Data Structure
error
boolean
reason
string
data
array[object]
segment
string

Segment value

count
number

Number of occurences of this segment

  • GEThttps://api.crisp.chat/v1/website/website_id/conversations/suggest/segments/page_number
  • Tiersuserplugin
  • Scopeswebsite:conversation:suggest
HTTP
Code
(loading)
Result
(loading)

Delete Suggested Conversation Segment

DELETE
/website/{website_id}/conversations/suggest/segment

Deletes a suggested conversation segment for website.

URI Parameters
website_id
stringRequired

The website identifier

Data Structure
segment
stringRequired

Segment to be deleted from suggestions

  • DELETEhttps://api.crisp.chat/v1/website/website_id/conversations/suggest/segment
  • Tiersuserplugin
  • Scopeswebsite:conversation:suggest
HTTP
Code
(loading)
Result
(loading)

List Suggested Conversation Data Keys

GET
/website/{website_id}/conversations/suggest/data/{page_number}

Lists suggested conversation data keys for website.

URI Parameters
website_id
stringRequired

The website identifier

page_number
stringOptional

The page number (paging in data list)

Data Structure
error
boolean
reason
string
data
array[object]
key
string

Data key value

count
number

Number of occurences of this data key

  • GEThttps://api.crisp.chat/v1/website/website_id/conversations/suggest/data/page_number
  • Tiersuserplugin
  • Scopeswebsite:conversation:suggest
HTTP
Code
(loading)
Result
(loading)

Delete Suggested Conversation Data Key

DELETE
/website/{website_id}/conversations/suggest/data

Deletes a suggested conversation data key for website.

URI Parameters
website_id
stringRequired

The website identifier

Data Structure
key
stringRequired

Data key to be deleted from suggestions

  • DELETEhttps://api.crisp.chat/v1/website/website_id/conversations/suggest/data
  • Tiersuserplugin
  • Scopeswebsite:conversation:suggest
HTTP
Code
(loading)
Result
(loading)

Conversationin Website

Create A New Conversation

POST
/website/{website_id}/conversation

Creates a new conversation.

URI Parameters
website_id
stringRequired

The website identifier

Data Structure
error
boolean
reason
string
data
object
session_id
string

Created conversation session identifier

  • POSThttps://api.crisp.chat/v1/website/website_id/conversation
  • Tiersuserplugin
  • Scopeswebsite:conversation:initiate
HTTP
Code
(loading)
Result
(loading)

Check If Conversation Exists

HEAD
/website/{website_id}/conversation/{session_id}

Checks if given conversation session identifier exists.

URI Parameters
website_id
stringRequired

The website identifier

session_id
stringRequired

The conversation session identifier

  • HEADhttps://api.crisp.chat/v1/website/website_id/conversation/session_id
  • Tiersuserplugin
  • Scopeswebsite:conversation:sessions
HTTP
Code
(loading)
Result
(loading)

Get A Conversation

GET
/website/{website_id}/conversation/{session_id}

Resolves conversation information.

URI Parameters
website_id
stringRequired

The website identifier

session_id
stringRequired

The conversation session identifier

Data Structure
error
boolean
reason
string
data
object
session_id
string

Session identifier

website_id
string

Website identifier

people_id
string

People identifier

state
enum[string]

Conversation state

Values

  • pending
  • unresolved
  • resolved
status
enum[number]

Conversation status (an alias of state; useful for sorting conversations)

Values

  • 1
  • 2
is_verified
boolean

Whether session is verified or not (user email ownership is authenticated)

is_blocked
boolean

Whether session is blocked or not (block messages from visitor)

availability
enum[string]

Visitor availability

Values

  • online
  • offline
active
object

User activity statistics (eg. moved their mouse if reported from the Crisp chatbox)

now
boolean

Whether user is considered active right now or not

last
number

Timestamp at which the user was last active

last_message
string

Last message excerpt

mentions
array[string]

Mentioned user identifiers (from conversation messages)

participants
array[object]

External participants for this conversation

type
enum[string]

External participant type

Values

  • email
target
string

External participant target (ie. email address, identifier, etc.)

created_at
number

Conversation creation timestamp

updated_at
number

Conversation update timestamp

compose
object

Compose states

operator
object

Compose state for operator

type
enum[string]

Compose state type

Values

  • start
  • stop
excerpt
string

Message excerpt for compose state

timestamp
number

Timestamp for compose state

user
object

Compose user information

user_id
string

Compose user identifier

nickname
string

Compose user nickname

avatar
string

Compose user avatar

visitor
object

Compose state for visitor

type
enum[string]

Compose state type

Values

  • start
  • stop
excerpt
string

Message excerpt for compose state

timestamp
number

Timestamp for compose state

unread
object

Unread messages counters

operator
number

Unread messages counter for operator

visitor
number

Unread messages counter for visitor

assigned
object

Assigned operator (if any)

user_id
string

Operator user identifier

meta
object

Meta-data for conversation

nickname
string

Visitor nickname

email
string

Visitor email

phone
string

Visitor phone

address
string

Visitor address

ip
string

Visitor IP address

data
object

Visitor data

avatar
string

Visitor avatar

device
object

Device information

capabilities
array[enum[string]]

Visitor device capabilities

Values

  • browsing
  • call
geolocation
object

Geolocation information for visitor device

country
string

Country code

region
string

Region code

city
string

City name

coordinates
object

Location coordinates

latitude
number

Latitude coordinate

longitude
number

Longitude coordinate

system
object

Visitor device system information

os
object

Operating system information

version
string

OS version

name
string

OS name

engine
object

Rendering engine information

version
string

Engine version

name
string

Engine name

browser
object

Browser information

major
string

Browser major version (eg: version 8.1 has a major of 8)

version
string

Browser version

name
string

Browser name

useragent
string

Visitor user agent

timezone
number

Visitor device timezone offset (UTC)

locales
array[string]

Visitor device locales

segments
array[string]

Segments attributed to conversation

  • GEThttps://api.crisp.chat/v1/website/website_id/conversation/session_id
  • Tiersuserplugin
  • Scopeswebsite:conversation:sessions
HTTP
Code
(loading)
Result
(loading)

Remove A Conversation

DELETE
/website/{website_id}/conversation/{session_id}

Removes a conversation in website.

URI Parameters
website_id
stringRequired

The website identifier

session_id
stringRequired

The conversation session identifier

Data Structure
error
boolean
reason
string
data
object
  • DELETEhttps://api.crisp.chat/v1/website/website_id/conversation/session_id
  • Tiersuserplugin
  • Scopeswebsite:conversation:sessions
HTTP
Code
(loading)
Result
(loading)

Initiate A Conversation With Existing Session

POST
/website/{website_id}/conversation/{session_id}/initiate

Initiates a conversation from an existing session.

Used to initiate a conversation from website visitor list, and trigger a chatbox open.

The client acknowledgement is sent back asynchronously on the RTM Events channel, using the event namespace session:request:initiated.

URI Parameters
website_id
stringRequired

The website identifier

session_id
stringRequired

The conversation session identifier

Data Structure
error
boolean
reason
string
data
object
  • POSThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/initiate
  • Tiersuserplugin
  • Scopeswebsite:conversation:initiate
HTTP
Code
(loading)
Result
(loading)

Get Messages In Conversation

GET
/website/{website_id}/conversation/{session_id}/messages{?timestamp_before}

Resolves messages in an existing conversation. Returns the last batch of messages if there are many messages in the conversation. Then, messages can be paged up to most recent message using the timestamp_before parameter.

URI Parameters
website_id
stringRequired

The website identifier

session_id
stringRequired

The conversation session identifier

timestamp_before
stringOptional

Returned message batch should end before given timestamp (used for infinite scroll paging)

Data Structure
error
boolean
reason
string
data
array[object]
session_id
string

Session identifier

website_id
string

Website identifier

type
enum[string]

Message type

Values

  • text
  • note
  • file
  • animation
  • audio
  • picker
  • field
  • event
from
enum[string]

Message sender

Values

  • user
  • operator
origin
enum[string]

Message origin

Values

  • chat
  • email
  • urn:*
content
object

Message content (string if type is text or note, object if type is file, animation, audio, picker, field or event)

id
string

Object identifier (only set if message type is picker or field)

text
string

Object text (only set if message type is picker, field or event)

explain
string

Object explanatory text (only set if message type is field)

value
string

Object value (only set if message type is field)

choices
array[object]

Object choices (only set if message type is picker)

value
string

Choice value

label
string

Choice label

selected
boolean

Whether choice is selected or not

name
string

Object name (only set if message type is file)

duration
number

Object duration in seconds (only set if message type is audio)

url
string

Object URL (only set if message type is file, animation or audio)

type
string

Object MIME type (only set if message type is file, animation or audio)

namespace
enum[string]

Event namespace (only set if message type is event)

Values

  • state:resolved
  • user:blocked
  • reminder:scheduled
  • thread:started
  • thread:ended
  • participant:added
  • participant:removed
  • call:started
  • call:ended
preview
array[object]

Preview of URLs contained in message

url
string

Previewed URL

website
string

Website domain for previewed URL

title
string

Page title for previewed URL

preview
object

Preview information

excerpt
string

Text excerpt from the page (may not be set)

image
string

Main image from the page (may not be set)

embed
string

Embeddable frame of main page media (may not be set)

stamped
boolean

Whether message was fully processed in the internal Crisp pipeline (eg: preview was done)

edited
boolean

Whether message was edited after being sent or not

translated
boolean

Whether message was auto-translated or not

mentions
array[string]

Mentioned user identifiers

read
enum[string]

Channel in which message has been read (can be empty)

Values

  • chat
  • email
  • urn:*
delivered
enum[string]

Channel in which message has lastly been delivered (can be empty)

Values

  • chat
  • email
  • urn:*
fingerprint
number

Unique message fingerprint (useful to avoid duplicates when using the API as per with the real-time sockets)

timestamp
number

Timestamp at which the message was sent

user
object

Sending user information

type
enum[string]

Sending user type (if any)

Values

  • website
  • participant
user_id
string

Sending user identifier (may be operator user identifier or session identifier)

nickname
string

Sending user nickname

avatar
string

Sending user avatar

original
object

Original message data (if any)

original_id
string

Original identifier

  • GEThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/messages
  • Tiersuserplugin
  • Scopeswebsite:conversation:messages
HTTP
Code
(loading)
Result
(loading)

Send A Message In Conversation

POST
/website/{website_id}/conversation/{session_id}/message

Sends a message in an existing conversation.

URI Parameters
website_id
stringRequired

The website identifier

session_id
stringRequired

The conversation session identifier

Data Structure
type
enum[string]Required

Message type

Values

  • text
  • note
  • file
  • animation
  • audio
  • picker
  • field
  • event
from
enum[string]Required

Message sender

Values

  • user
  • operator
origin
enum[string]Required

Message origin

Values

  • chat
  • email
  • urn:*
content
objectRequired

Message content (string if type is text or note, object if type is file, animation, audio, picker, field or event)

id
stringRequired

Object identifier (only set if message type is picker or field)

text
stringRequired

Object text (only set if message type is picker, field or event)

explain
stringRequired

Object explanatory text (only set if message type is field)

value
stringOptional

Object value (only set if message type is field)

choices
array[object]Required

Object choices (only set if message type is picker)

value
stringRequired

Choice value

label
stringRequired

Choice label

selected
booleanRequired

Whether choice is selected or not

name
stringRequired

Object name (only set if message type is file)

duration
numberRequired

Object duration in seconds (only set if message type is audio)

url
stringRequired

Object URL (only set if message type is file, animation or audio)

type
stringRequired

Object MIME type (only set if message type is file, animation or audio)

namespace
enum[string]Required

Event namespace (only set if message type is event)

Values

  • state:resolved
  • user:blocked
  • reminder:scheduled
  • thread:started
  • thread:ended
  • participant:added
  • participant:removed
  • call:started
  • call:ended
mentions
array[string]Optional

Mentioned user identifiers

fingerprint
numberOptional

Unique message fingerprint (useful to avoid duplicates when using the API as per with the real-time sockets)

user
objectOptional

Sending user information

type
enum[string]Optional

Sending user type

Values

  • website
  • participant
nickname
stringOptional

Sending user nickname

avatar
stringOptional

Sending user avatar

original
objectOptional

Original message data (if set, original data will then be available on a separate route)

type
enum[string]Required

Original message data MIME type

Values

  • text/html
content
stringRequired

Original message data content

translated
booleanOptional

Whether message was auto-translated or not

  • POSThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/message
  • Tiersuserplugin
  • Scopeswebsite:conversation:messages
HTTP
Code
(loading)
Result
(loading)

Get A Message In Conversation

GET
/website/{website_id}/conversation/{session_id}/message/{fingerprint}

Resolves an existing message in an existing conversation.

URI Parameters
website_id
stringRequired

The website identifier

session_id
stringRequired

The conversation session identifier

fingerprint
stringRequired

The message fingerprint

Data Structure
error
boolean
reason
string
data
object
session_id
string

Session identifier

website_id
string

Website identifier

type
enum[string]

Message type

Values

  • text
  • note
  • file
  • animation
  • audio
  • picker
  • field
  • event
from
enum[string]

Message sender

Values

  • user
  • operator
origin
enum[string]

Message origin

Values

  • chat
  • email
  • urn:*
content
object

Message content (string if type is text or note, object if type is file, animation, audio, picker, field or event)

id
string

Object identifier (only set if message type is picker or field)

text
string

Object text (only set if message type is picker, field or event)

explain
string

Object explanatory text (only set if message type is field)

value
string

Object value (only set if message type is field)

choices
array[object]

Object choices (only set if message type is picker)

value
string

Choice value

label
string

Choice label

selected
boolean

Whether choice is selected or not

name
string

Object name (only set if message type is file)

duration
number

Object duration in seconds (only set if message type is audio)

url
string

Object URL (only set if message type is file, animation or audio)

type
string

Object MIME type (only set if message type is file, animation or audio)

namespace
enum[string]

Event namespace (only set if message type is event)

Values

  • state:resolved
  • user:blocked
  • reminder:scheduled
  • thread:started
  • thread:ended
  • participant:added
  • participant:removed
  • call:started
  • call:ended
preview
array[object]

Preview of URLs contained in message

url
string

Previewed URL

website
string

Website domain for previewed URL

title
string

Page title for previewed URL

preview
object

Preview information

excerpt
string

Text excerpt from the page (may not be set)

image
string

Main image from the page (may not be set)

embed
string

Embeddable frame of main page media (may not be set)

stamped
boolean

Whether message was fully processed in the internal Crisp pipeline (eg: preview was done)

edited
boolean

Whether message was edited after being sent or not

translated
boolean

Whether message was auto-translated or not

mentions
array[string]

Mentioned user identifiers

read
enum[string]

Channel in which message has been read (can be empty)

Values

  • chat
  • email
  • urn:*
delivered
enum[string]

Channel in which message has lastly been delivered (can be empty)

Values

  • chat
  • email
  • urn:*
fingerprint
number

Unique message fingerprint (useful to avoid duplicates when using the API as per with the real-time sockets)

timestamp
number

Timestamp at which the message was sent

user
object

Sending user information

type
enum[string]

Sending user type (if any)

Values

  • website
  • participant
user_id
string

Sending user identifier (may be operator user identifier or session identifier)

nickname
string

Sending user nickname

avatar
string

Sending user avatar

original
object

Original message data (if any)

original_id
string

Original identifier

  • GEThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/message/fingerprint
  • Tiersuserplugin
  • Scopeswebsite:conversation:messages
HTTP
Code
(loading)
Result
(loading)

Update A Message In Conversation

PATCH
/website/{website_id}/conversation/{session_id}/message/{fingerprint}

Edits an existing message in an existing conversation.

The updated event is sent back asynchronously on the RTM Events channel, using the event namespace message:updated.

URI Parameters
website_id
stringRequired

The website identifier

session_id
stringRequired

The conversation session identifier

fingerprint
stringRequired

The edited message fingerprint

Data Structure
content
objectRequired

Message content (string if type is text or note, object if type is file, animation, audio, picker, field or event)

id
stringRequired

Object identifier (only set if message type is picker or field)

text
stringRequired

Object text (only set if message type is picker, field or event)

explain
stringRequired

Object explanatory text (only set if message type is field)

value
stringOptional

Object value (only set if message type is field)

choices
array[object]Required

Object choices (only set if message type is picker)

value
stringRequired

Choice value

label
stringRequired

Choice label

selected
booleanRequired

Whether choice is selected or not

name
stringRequired

Object name (only set if message type is file)

duration
numberRequired

Object duration in seconds (only set if message type is audio)

url
stringRequired

Object URL (only set if message type is file, animation or audio)

type
stringRequired

Object MIME type (only set if message type is file, animation or audio)

namespace
enum[string]Required

Event namespace (only set if message type is event)

Values

  • state:resolved
  • user:blocked
  • reminder:scheduled
  • thread:started
  • thread:ended
  • participant:added
  • participant:removed
  • call:started
  • call:ended
  • PATCHhttps://api.crisp.chat/v1/website/website_id/conversation/session_id/message/fingerprint
  • Tiersuserplugin
  • Scopeswebsite:conversation:messages
HTTP
Code
(loading)
Result
(loading)

Compose A Message In Conversation

PATCH
/website/{website_id}/conversation/{session_id}/compose

Starts or stop composing a message in an existing conversation.

URI Parameters
website_id
stringRequired

The website identifier

session_id
stringRequired

The conversation session identifier

Data Structure
type
enum[string]Required

Compose type

Values

  • start
  • stop
from
enum[string]Required

Compose sender

Values

  • user
  • operator
excerpt
stringOptional

Compose excerpt (MagicType preview)

stealth
booleanOptional

Compose stealth mode (ie. do not propagate compose to the other party)

  • PATCHhttps://api.crisp.chat/v1/website/website_id/conversation/session_id/compose
  • Tiersuserplugin
  • Scopeswebsite:conversation:messages
HTTP
Code
(loading)
Result
(loading)

Mark Messages As Read In Conversation

PATCH
/website/{website_id}/conversation/{session_id}/read

Marks messages as read in conversation. Either using given message fingerprints, or all messages.

URI Parameters
website_id
stringRequired

The website identifier

session_id
stringRequired

The conversation session identifier

Data Structure
from
enum[string]Required

Sender direction

Values

  • user
  • operator
origin
enum[string]Required

Read receipt origin

Values

  • chat
  • email
  • urn:*
fingerprints
array[number]Optional

Target message fingerprints (if not set, this marks all messages as read in conversation)

  • PATCHhttps://api.crisp.chat/v1/website/website_id/conversation/session_id/read
  • Tiersuserplugin
  • Scopeswebsite:conversation:messages
HTTP
Code
(loading)
Result
(loading)

Mark Messages As Delivered In Conversation

PATCH
/website/{website_id}/conversation/{session_id}/delivered

Marks messages as delivered in conversation.

URI Parameters
website_id
stringRequired

The website identifier

session_id
stringRequired

The conversation session identifier

Data Structure
from
enum[string]Required

Sender direction

Values

  • operator
origin
enum[string]Required

Delivered receipt origin

Values

  • chat
  • email
  • urn:*
fingerprints
array[number]Required

Target message fingerprints

  • PATCHhttps://api.crisp.chat/v1/website/website_id/conversation/session_id/delivered
  • Tiersuserplugin
  • Scopeswebsite:conversation:messages
HTTP
Code
(loading)
Result
(loading)

Update Conversation Open State

PATCH
/website/{website_id}/conversation/{session_id}/open

Updates conversation open state for authenticated operator user. Lets other operators see which conversation people are on at any given moment. This state automatically expires after a while, if not renewed.

URI Parameters
website_id
stringRequired

The website identifier

session_id
stringRequired

The conversation session identifier

Data Structure
opened
booleanRequired

Open state

  • PATCHhttps://api.crisp.chat/v1/website/website_id/conversation/session_id/open
  • Tiersuserplugin
  • Scopeswebsite:conversation:actions
HTTP
Code
(loading)
Result
(loading)

Get Conversation Routing Assign

GET
/website/{website_id}/conversation/{session_id}/routing

Resolves assigned operator for conversation routing.

URI Parameters
website_id
stringRequired

The website identifier

session_id
stringRequired

The conversation session identifier

Data Structure
error
boolean
reason
string
data
object
assigned
object

Assigned operator (if any)

user_id
string

Operator user identifier

  • GEThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/routing
  • Tiersuserplugin
  • Scopeswebsite:conversation:routing
HTTP
Code
(loading)
Result
(loading)

Assign Conversation Routing

PATCH
/website/{website_id}/conversation/{session_id}/routing

Assigns conversation routing to an operator, or unassign.

URI Parameters
website_id
stringRequired

The website identifier

session_id
stringRequired

The conversation session identifier

Data Structure
assigned
objectRequired

Assigned operator (set to blank value for none)

user_id
stringRequired

Operator user identifier

  • PATCHhttps://api.crisp.chat/v1/website/website_id/conversation/session_id/routing
  • Tiersuserplugin
  • Scopeswebsite:conversation:routing
HTTP
Code
(loading)
Result
(loading)

Get Conversation Metas

GET
/website/{website_id}/conversation/{session_id}/meta

Resolves conversation meta information.

URI Parameters
website_id
stringRequired

The website identifier

session_id
stringRequired

The conversation session identifier

Data Structure
error
boolean
reason
string
data
object
nickname
string

Visitor nickname

email
string

Visitor email

phone
string

Visitor phone

address
string

Visitor address

ip
string

Visitor IP address

data
object

Visitor data

avatar
string

Visitor avatar

device
object

Device information

capabilities
array[enum[string]]

Visitor device capabilities

Values

  • browsing
  • call
geolocation
object

Geolocation information for visitor device

country
string

Country code

region
string

Region code

city
string

City name

coordinates
object

Location coordinates

latitude
number

Latitude coordinate

longitude
number

Longitude coordinate

system
object

Visitor device system information

os
object

Operating system information

version
string

OS version

name
string

OS name

engine
object

Rendering engine information

version
string

Engine version

name
string

Engine name

browser
object

Browser information

major
string

Browser major version (eg: version 8.1 has a major of 8)

version
string

Browser version

name
string

Browser name

useragent
string

Visitor user agent

timezone
number

Visitor device timezone offset (UTC)

locales
array[string]

Visitor device locales

segments
array[string]

Segments attributed to conversation

  • GEThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/meta
  • Tiersuserplugin
  • Scopeswebsite:conversation:sessions
HTTP
Code
(loading)
Result
(loading)

Update Conversation Metas

PATCH
/website/{website_id}/conversation/{session_id}/meta

Updates conversation meta information.

URI Parameters
website_id
stringRequired

The website identifier

session_id
stringRequired

The conversation session identifier

Data Structure
nickname
stringOptional

Visitor nickname

email
stringOptional

Visitor email

avatar
stringOptional

Visitor avatar

ip
stringOptional

Visitor IP address

data
objectOptional

Visitor data

phone
stringOptional

Visitor phone number

address
stringOptional

Visitor address

segments
array[string]Optional

Segments for conversation

device
objectOptional

Visitor device information

capabilities
array[enum[string]]Optional

Visitor device capabilities

Values

  • browsing
  • call
geolocation
objectOptional

Geolocation information for visitor device

country
stringOptional

Country code (can be blank)

region
stringOptional

Region code (can be blank)

city
stringOptional

City name (can be blank)

coordinates
objectRequired

Location coordinates

latitude
numberRequired

Latitude coordinate

longitude
numberRequired

Longitude coordinate

system
objectOptional

Visitor device system information

os
objectOptional

Operating system information

version
stringRequired

OS version

name
stringRequired

OS name

engine
objectOptional

Rendering engine information

version
stringRequired

Engine version

name
stringRequired

Engine name

browser
objectOptional

Browser information

major
stringRequired

Browser major version (eg: version 8.1 has a major of 8)

version
stringRequired

Browser version

name
stringRequired

Browser name

useragent
stringRequired

Visitor user agent

timezone
numberOptional

Visitor device timezone offset (UTC)

locales
array[string]Optional

Visitor device locales

  • PATCHhttps://api.crisp.chat/v1/website/website_id/conversation/session_id/meta
  • Tiersuserplugin
  • Scopeswebsite:conversation:sessions
HTTP
Code
(loading)
Result
(loading)

Get An Original Message In Conversation

GET
/website/{website_id}/conversation/{session_id}/original/{original_id}

Resolves an existing original message in an existing conversation.

URI Parameters
website_id
stringRequired

The website identifier

session_id
stringRequired

The conversation session identifier

original_id
stringRequired

The original identifier

Data Structure
error
boolean
reason
string
data
object
website_id
string

Website identifier

session_id
string

Session identifier

original_id
string

Original identifier

type
enum[string]

Original message data MIME type

Values

  • text/html
content
string

Original message data content

timestamp
number

Timestamp at which the original was stored

  • GEThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/original/original_id
  • Tiersuserplugin
  • Scopeswebsite:conversation:messages
HTTP
Code
(loading)
Result
(loading)

List Conversation Pages

GET
/website/{website_id}/conversation/{session_id}/pages/{page_number}

Lists browsed pages in conversation.

URI Parameters
website_id
stringRequired

The website identifier

session_id
stringRequired

The conversation session identifier

page_number
stringOptional

The page number (paging in page list)

Data Structure
error
boolean
reason
string
data
array[object]
page_title
string

Page title as seen by visitor browser

page_url
string

Page URL

page_referrer
string

Page referrer (if any)

timestamp
number

Timestamp of page access (when the page was loaded)

  • GEThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/pages/page_number
  • Tiersuserplugin
  • Scopeswebsite:conversation:pages
HTTP
Code
(loading)
Result
(loading)

List Conversation Events

GET
/website/{website_id}/conversation/{session_id}/events/{page_number}

Lists stacked events in conversation.

URI Parameters
website_id
stringRequired

The website identifier

session_id
stringRequired

The conversation session identifier

page_number
stringOptional

The page number (paging in event list)

Data Structure
error
boolean
reason
string
data
array[object]
text
string

Text for event

data
object

Data for event (if any)

color
enum[string]

Color for event (if any)

Values

  • red
  • orange
  • yellow
  • green
  • blue
  • purple
  • pink
  • brown
  • grey
  • black
timestamp
number

Timestamp of event (when the event was stacked)

  • GEThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/events/page_number
  • Tiersuserplugin
  • Scopeswebsite:conversation:events
HTTP
Code
(loading)
Result
(loading)

Get Conversation State

GET
/website/{website_id}/conversation/{session_id}/state

Resolves conversation state.

URI Parameters
website_id
stringRequired

The website identifier

session_id
stringRequired

The conversation session identifier

Data Structure
error
boolean
reason
string
data
object
state
enum[string]

Conversation state

Values

  • pending
  • unresolved
  • resolved
  • GEThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/state
  • Tiersuserplugin
  • Scopeswebsite:conversation:states
HTTP
Code
(loading)
Result
(loading)

Change Conversation State

PATCH
/website/{website_id}/conversation/{session_id}/state

Updates conversation state.

URI Parameters
website_id
stringRequired

The website identifier

session_id
stringRequired

The conversation session identifier

Data Structure
state
enum[string]Required

Conversation state

Values

  • pending
  • unresolved
  • resolved
  • PATCHhttps://api.crisp.chat/v1/website/website_id/conversation/session_id/state
  • Tiersuserplugin
  • Scopeswebsite:conversation:states
HTTP
Code
(loading)
Result
(loading)

Get Conversation Participants

GET
/website/{website_id}/conversation/{session_id}/participants

Resolves conversation participants (external participants, eg. emails to be set in CC).

URI Parameters
website_id
stringRequired

The website identifier

session_id
stringRequired

The conversation session identifier

Data Structure
error
boolean
reason
string
data
object
participants
array[object]

External participants for conversation

type
enum[string]

External participant type

Values

  • email
target
string

External participant target (ie. email address, identifier, etc.)

  • GEThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/participants
  • Tiersuserplugin
  • Scopeswebsite:conversation:participants
HTTP
Code
(loading)
Result
(loading)

Save Conversation Participants

PUT
/website/{website_id}/conversation/{session_id}/participants

Saves conversation participants (external participants, eg. emails to be set in CC).

URI Parameters
website_id
stringRequired

The website identifier

session_id
stringRequired

The conversation session identifier

Data Structure
participants
array[object]Required

External participants for conversation

type
enum[string]Required

External participant type

Values

  • email
target
stringRequired

External participant target (ie. email address, identifier, etc.)

  • PUThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/participants
  • Tiersuserplugin
  • Scopeswebsite:conversation:participants
HTTP
Code
(loading)
Result
(loading)

Get Block Status For Conversation

GET
/website/{website_id}/conversation/{session_id}/block

Resolves conversation block status.

URI Parameters
website_id
stringRequired

The website identifier

session_id
stringRequired

The conversation session identifier

Data Structure
error
boolean
reason
string
data
object
blocked
boolean

Block state

  • GEThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/block
  • Tiersuserplugin
  • Scopeswebsite:conversation:actions
HTTP
Code
(loading)
Result
(loading)

Block Incoming Messages For Conversation

PATCH
/website/{website_id}/conversation/{session_id}/block

Blocks further incoming messages from a conversation. Messages from visitor will be silently dropped, but you can still send messages to visitor.

URI Parameters
website_id
stringRequired

The website identifier

session_id
stringRequired

The conversation session identifier

Data Structure
blocked
booleanRequired

Block state

  • PATCHhttps://api.crisp.chat/v1/website/website_id/conversation/session_id/block
  • Tiersuserplugin
  • Scopeswebsite:conversation:actions
HTTP
Code
(loading)
Result
(loading)

Request Email Transcript For Conversation

POST
/website/{website_id}/conversation/{session_id}/transcript

Requests an email transcript for a conversation. The transcript is emailed to the authenticated user, or to the indicated email. It contains all conversation history and may be kept for as an external record.

URI Parameters
website_id
stringRequired

The website identifier

session_id
stringRequired

The conversation session identifier

Data Structure
to
enum[string]Required

Target user to send the transcript to

Values

  • user
  • operator
email
stringOptional

Target email (if not set, the transcript is sent to the email address of the target user)

  • POSThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/transcript
  • Tiersuserplugin
  • Scopeswebsite:conversation:actions
HTTP
Code
(loading)
Result
(loading)

Request Chatbox Binding Purge For Conversation

POST
/website/{website_id}/conversation/{session_id}/purge

Requests a chatbox binding purge for conversation. The visitor must be online for the purge to be proceeded.

URI Parameters
website_id
stringRequired

The website identifier

session_id
stringRequired

The conversation session identifier

Data Structure
error
boolean
reason
string
data
object
  • POSThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/purge
  • Tiersuserplugin
  • Scopeswebsite:conversation:actions
HTTP
Code
(loading)
Result
(loading)

List Browsing Sessions For Conversation

GET
/website/{website_id}/conversation/{session_id}/browsing

Lists available browsing sessions for conversation. A browsing session can be initiated to stream user screen content to operators.

URI Parameters
website_id
stringRequired

The website identifier

session_id
stringRequired

The conversation session identifier

Data Structure
error
boolean
reason
string
data
array[object]
browsing_id
string

Browsing session identifier

browsing_token
string

Browsing token (used to authenticate cross-channel requests, eg. to the HTTP proxy)

useragent
string

Useragent for browsing session

  • GEThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/browsing
  • Tiersuserplugin
  • Scopeswebsite:conversation:browsing
HTTP
Code
(loading)
Result
(loading)

Initiate Browsing Session For Conversation

POST
/website/{website_id}/conversation/{session_id}/browsing

Initiates browsing session for conversation.

Used to ask a client to prepare for a streamed browsing session for all open tabs, and request acknowledgement of when the client is ready to accept browsing stream actions (one acknowledgement per tab).

The client acknowledgement is sent back asynchronously on the RTM Events channel, using the event namespace browsing:request:initiated if initiated, or browsing:request:rejected if not initiated.

URI Parameters
website_id
stringRequired

The website identifier

session_id
stringRequired

The conversation session identifier

Data Structure
error
boolean
reason
string
data
object
  • POSThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/browsing
  • Tiersuserplugin
  • Scopeswebsite:conversation:browsing
HTTP
Code
(loading)
Result
(loading)

Send Action To An Existing Browsing Session

PATCH
/website/{website_id}/conversation/{session_id}/browsing/{browsing_id}

Sends an action to an existing browsing session. Used to send stream actions to a browsing session (eg. to start or stop the stream session).

The client acknowledgement is sent back asynchronously on the streaming channel, using either the event namespace app:browsing:action:started or app:browsing:action:stopped (depending on the request action parameter, if action is start or stop).

URI Parameters
website_id
stringRequired

The website identifier

session_id
stringRequired

The conversation session identifier

browsing_id
stringRequired

The browsing session identifier

Data Structure
action
enum[string]Required

Browsing action

Values

  • start
  • stop
  • heartbeat
  • PATCHhttps://api.crisp.chat/v1/website/website_id/conversation/session_id/browsing/browsing_id
  • Tiersuserplugin
  • Scopeswebsite:conversation:browsing
HTTP
Code
(loading)
Result
(loading)

Debug An Existing Browsing Session

PATCH
/website/{website_id}/conversation/{session_id}/browsing/{browsing_id}/debug

Debugs an existing browsing session. Used by LiveDebug™ to start or stop a debug session, as well as execute remote JavaScript on the user browser.

The debug stream is sent back asynchronously on the streaming channel, using either the event namespace app:browsing:debug:started, app:browsing:debug:stopped, app:browsing:debug:executed or app:browsing:debug:stream.

URI Parameters
website_id
stringRequired

The website identifier

session_id
stringRequired

The conversation session identifier

browsing_id
stringRequired

The browsing session identifier

Data Structure
action
enum[string]Required

Debug action

Values

  • start
  • stop
  • heartbeat
  • execute
execute
stringOptional

JavaScript code to execute in browsing session (action must be execute)

  • PATCHhttps://api.crisp.chat/v1/website/website_id/conversation/session_id/browsing/browsing_id/debug
  • Tiersuserplugin
  • Scopeswebsite:conversation:browsing
HTTP
Code
(loading)
Result
(loading)

Assist An Existing Browsing Session

PATCH
/website/{website_id}/conversation/{session_id}/browsing/{browsing_id}/assist

Assists an existing browsing session. Used by LiveAssist™ to start or stop an assist session, used by operators to take control on the screen of user browser (mouse move and scroll).

The client acknowledgement is sent back asynchronously on the streaming channel, using either the event namespace app:browsing:assist:started or app:browsing:assist:stopped (depending on the request action parameter, if action is start or stop). Other actions do not imply real-time feedbacks.

URI Parameters
website_id
stringRequired

The website identifier

session_id
stringRequired

The conversation session identifier

browsing_id
stringRequired

The browsing session identifier

Data Structure
action
enum[string]Required

Assist action

Values

  • start
  • stop
  • heartbeat
  • mouse
  • scroll
  • click
mouse
objectOptional

Mouse position for assist cursor in browsing session (action must be mouse)

x
numberRequired

Mouse cursor horizontal position

y
numberRequired

Mouse cursor vertical position

click
objectOptional

Click target for assist cursor in browsing session (action must be click)

x
numberRequired

Click cursor horizontal position

y
numberRequired

Click cursor vertical position

scroll
objectOptional

Scroll position for assist scroll wheel in browsing session (action must be scroll)

x
numberRequired

Scroll wheel horizontal position

y
numberRequired

Scroll wheel vertical position

  • PATCHhttps://api.crisp.chat/v1/website/website_id/conversation/session_id/browsing/browsing_id/assist
  • Tiersuserplugin
  • Scopeswebsite:conversation:browsing
HTTP
Code
(loading)
Result
(loading)

Initiate New Call Session For Conversation

POST
/website/{website_id}/conversation/{session_id}/call

Initiates a new audio/video call session for conversation.

Used to request a client to open a call session (audio + video). The client acknowledgement is sent back asynchronously on the RTM Events channel, using either the event namespace call:request:accept or call:request:decline.

URI Parameters
website_id
stringRequired

The website identifier

session_id
stringRequired

The conversation session identifier

Data Structure
mode
enum[string]Required

Mode of the call to start

Values

  • video
  • audio
  • POSThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/call
  • Tiersuserplugin
  • Scopeswebsite:conversation:calls
HTTP
Code
(loading)
Result
(loading)

Get Ongoing Call Session For Conversation

GET
/website/{website_id}/conversation/{session_id}/call

Gets the ongoing audio/video call session for conversation.

URI Parameters
website_id
stringRequired

The website identifier

session_id
stringRequired

The conversation session identifier

Data Structure
error
boolean
reason
string
data
object
call_id
string

Call session identifier (if any call ongoing)

  • GEThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/call
  • Tiersuserplugin
  • Scopeswebsite:conversation:calls
HTTP
Code
(loading)
Result
(loading)

Abort Ongoing Call Session For Conversation

DELETE
/website/{website_id}/conversation/{session_id}/call/{call_id}

Aborts the ongoing audio/video call session for conversation.

URI Parameters
website_id
stringRequired

The website identifier

session_id
stringRequired

The conversation session identifier

call_id
stringRequired

The call identifier

Data Structure
error
boolean
reason
string
data
object
  • DELETEhttps://api.crisp.chat/v1/website/website_id/conversation/session_id/call/call_id
  • Tiersuserplugin
  • Scopeswebsite:conversation:calls
HTTP
Code
(loading)
Result
(loading)

Transmit Signaling On Ongoing Call Session

PATCH
/website/{website_id}/conversation/{session_id}/call/{call_id}/signaling

Transmits a signaling payload for the ongoing audio/video call session for conversation.

Used to emit a signaling payload to the other client, that is also part of the call session. The client signaling payloads are sent back asynchronously on the streaming channel, using either the event namespace app:call:signaling:sdp or app:call:signaling:candidate.

URI Parameters
website_id
stringRequired

The website identifier

session_id
stringRequired

The conversation session identifier

call_id
stringRequired

The call identifier

Data Structure
type
enum[string]Required

Signaling type to transmit

Values

  • sdp
  • candidate
payload
objectRequired

Signaling payload to transmit

  • PATCHhttps://api.crisp.chat/v1/website/website_id/conversation/session_id/call/call_id/signaling
  • Tiersuserplugin
  • Scopeswebsite:conversation:calls
HTTP
Code
(loading)
Result
(loading)

Deliver Widget Button Action For Conversation

POST
/website/{website_id}/conversation/{session_id}/widget/{plugin_id}/button

Delivers a button action on plugin widget for conversation, used to perform an action on the plugin, eg. refund a user. A hook will be sent to the plugin widget receiver.

Delivery completion or failure will be acknowledged on the RTM Events channel, using the event namespace widget:action:processed.

URI Parameters
website_id
stringRequired

The website identifier

session_id
stringRequired

The conversation session identifier

plugin_id
stringRequired

The plugin identifier for widget

Data Structure
section_id
stringRequired

Widget section identifier

item_id
stringRequired

Widget item identifier

data
objectRequired

Data to be sent along the button hook (can be empty)

value
objectOptional

Value to be sent along the button hook (if any)

  • POSThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/widget/plugin_id/button
  • Tiersuser
HTTP
Code
(loading)
Result
(loading)

Deliver Widget Data Action For Conversation

POST
/website/{website_id}/conversation/{session_id}/widget/{plugin_id}/data

Delivers a data action on plugin widget for conversation, used to either fetch or edit a data value from the plugin, eg. fetch a user unpaid balance. A hook will be sent to the plugin widget receiver.

Delivery completion will be acknowledged on the RTM Events channel, using the event namespace widget:action:processed.

URI Parameters
website_id
stringRequired

The website identifier

session_id
stringRequired

The conversation session identifier

plugin_id
stringRequired

The plugin identifier for widget

Data Structure
section_id
stringRequired

Widget section identifier

item_id
stringRequired

Widget item identifier

action
enum[string]Required

Action to take on data

Values

  • fetch
  • edit
value
stringOptional

Replacement value for data (if action is edit)

  • POSThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/widget/plugin_id/data
  • Tiersuser
HTTP
Code
(loading)
Result
(loading)

Schedule A Reminder For Conversation

POST
/website/{website_id}/conversation/{session_id}/reminder

Schedules a reminder in the future for conversation, with a note to your future-self. A push notification and an email will be sent, as well as a note in the conversation.

URI Parameters
website_id
stringRequired

The website identifier

session_id
stringRequired

The conversation session identifier

Data Structure
date
stringRequired

Date in the future at which you want to be reminded (ISO 8601)

note
stringRequired

Note message to be sent as a reminder

  • POSThttps://api.crisp.chat/v1/website/website_id/conversation/session_id/reminder
  • Tiersuserplugin
  • Scopeswebsite:conversation:reminders
HTTP
Code
(loading)
Result
(loading)

Peoplein Website

Get People Statistics

GET
/website/{website_id}/people/stats

Resolves statistics on people in website.

URI Parameters
website_id
stringRequired

The website identifier

Data Structure
error
boolean
reason
string
data
object
total
number

Total number of people

  • GEThttps://api.crisp.chat/v1/website/website_id/people/stats
  • Tiersuserplugin
  • Scopeswebsite:people:statistics
HTTP
Code
(loading)
Result
(loading)

List Suggested People Segments

GET
/website/{website_id}/people/suggest/segments/{page_number}

Lists suggested segments for people.

URI Parameters
website_id
stringRequired

The website identifier

page_number
stringOptional

The page number (paging in segment list)

Data Structure
error
boolean
reason
string
data
array[object]
segment
string

Segment value

count
number

Number of occurences of this segment

  • GEThttps://api.crisp.chat/v1/website/website_id/people/suggest/segments/page_number
  • Tiersuserplugin
  • Scopeswebsite:people:suggest
HTTP
Code
(loading)
Result
(loading)

Delete Suggested People Segment

DELETE
/website/{website_id}/people/suggest/segment

Deletes a suggested segment for people.

URI Parameters
website_id
stringRequired

The website identifier

Data Structure
segment
stringRequired

Segment to be deleted from suggestions

  • DELETEhttps://api.crisp.chat/v1/website/website_id/people/suggest/segment
  • Tiersuserplugin
  • Scopeswebsite:people:suggest
HTTP
Code
(loading)
Result
(loading)

List Suggested People Data Keys

GET
/website/{website_id}/people/suggest/data/{page_number}

Lists suggested data keys for people.

URI Parameters
website_id
stringRequired

The website identifier

page_number
stringOptional

The page number (paging in data list)

Data Structure
error
boolean
reason
string
data
array[object]
key
string

Data key value

count
number

Number of occurences of this data key

  • GEThttps://api.crisp.chat/v1/website/website_id/people/suggest/data/page_number
  • Tiersuserplugin
  • Scopeswebsite:people:suggest
HTTP
Code
(loading)
Result
(loading)

Delete Suggested People Data Key

DELETE
/website/{website_id}/people/suggest/data

Deletes a suggested data key for people.

URI Parameters
website_id
stringRequired

The website identifier

Data Structure
key
stringRequired

Data key to be deleted from suggestions

  • DELETEhttps://api.crisp.chat/v1/website/website_id/people/suggest/data
  • Tiersuserplugin
  • Scopeswebsite:people:suggest
HTTP
Code
(loading)
Result
(loading)

List Suggested People Events

GET
/website/{website_id}/people/suggest/events/{page_number}

Lists suggested events for people.

URI Parameters
website_id
stringRequired

The website identifier

page_number
stringOptional

The page number (paging in event list)

Data Structure
error
boolean
reason
string
data
array[object]
text
string

Event text

count
number

Number of occurences of this event

  • GEThttps://api.crisp.chat/v1/website/website_id/people/suggest/events/page_number
  • Tiersuserplugin
  • Scopeswebsite:people:suggest
HTTP
Code
(loading)
Result
(loading)

Delete Suggested People Event

DELETE
/website/{website_id}/people/suggest/event

Deletes a suggested event for people.

URI Parameters
website_id
stringRequired

The website identifier

Data Structure
text
stringRequired

Event text to be deleted from suggestions

  • DELETEhttps://api.crisp.chat/v1/website/website_id/people/suggest/event
  • Tiersuserplugin
  • Scopeswebsite:people:suggest
HTTP
Code
(loading)
Result
(loading)

List People Profiles

GET
/website/{website_id}/people/profiles/{page_number}{?sort_field}{&sort_order}{&search_operator}{&search_filter}{&search_text}{&filter_date_start}{&filter_date_end}

Lists people profiles for website.

URI Parameters
website_id
stringRequired

The website identifier

page_number
stringOptional

Page number for people paging

sort_field
stringOptional

Sort on field (based on available search field names)

sort_order
stringOptional

Sort order (ascending or descending)

search_operator
stringOptional

Search operator (or or and respectful to boolean algebra, defaults to and if not set)

search_filter
stringOptional

Search filter (object filter mapped as string)

search_text
stringOptional

Search text (text for a quick search)

filter_date_start
stringOptional

When to start relative to profile creation date (date, ISO 8601)

filter_date_end
stringOptional

When to end relative to profile creation date (date, ISO 8601)

Data Structure
error
boolean
reason
string
data
array[object]
people_id
string

People identifier

email
string

Email for people profile

person
object

Personal information

nickname
string

Nickname for user (includes first name and last name)

avatar
string

Avatar for user

gender
enum[string]

Gender for user

Values

  • male
  • female
phone
string

Phone number for user

address
string

Address for user

description
string

Description for user

website
string

Website of user

timezone
number

Timezone offset of user (UTC)

profiles
array[object]

Online profiles for user

type
string

Profile type (eg: facebook, twitter)

handle
string

User handle on online platform

url
string

URL for the profile

employment
object

Employment information for user

name
string

Company name

domain
string

Company domain name

title
string

User title in company

role
string

User role in company

seniority
string

User seniority in company

geolocation
object

Geolocation information for user

country
string

Country code

region
string

Region code

city
string

City name

coordinates
object

Location coordinates

latitude
number

Latitude coordinate

longitude
number

Longitude coordinate

locales
array[string]

Locales supported by user (ISO 639-1)

company
object

Company information

name
string

Company name

legal_name
string

Company legal name

domain
string

Company domain name

url
string

Company website URL

description
string

Company description

timezone
number

Company timezone offset (UTC)

phones
array[string]

Company phone numbers

emails
array[string]

Company email addresses

geolocation
object

Company location

country
string

Country code

region
string

Region code

city
string

City name

coordinates
object

Location coordinates

latitude
number

Latitude coordinate

longitude
number

Longitude coordinate

metrics
object

Metrics for company

employees
number

Number of employees

market_cap
number

Market capitalization

raised
number

Money raised

arr
number

Annual Recurring Revenue

tags
array[string]

Tags for company

segments
array[string]

Segments attributed to people profile

notepad
string

Private notepad on people profile

active
object

User activity statistics (based on last active session from user)

now
boolean

Whether user is considered active right now or not

last
number

Timestamp at which the user was last active

score
number

Score associated to this profile, from 1 to 5 (based on ratings from user)

created_at
number

Profile creation timestamp

updated_at
number

Profile update timestamp

  • GEThttps://api.crisp.chat/v1/website/website_id/people/profiles/page_number
  • Tiersuserplugin
  • Scopeswebsite:people:profiles
HTTP
Code
(loading)
Result
(loading)

Add New People Profile

POST
/website/{website_id}/people/profile

Adds a new people profile.

URI Parameters
website_id
stringRequired

The website identifier

Data Structure
email
stringRequired

Email for people profile

person
objectRequired

Personal information

nickname
stringRequired

Nickname for user (includes first name and last name)

avatar
stringOptional

Avatar for user

gender
enum[string]Optional

Gender for user

Values

  • male
  • female
phone
stringOptional

Phone number for user

address
stringOptional

Address for user

description
stringOptional

Description for user

website
stringOptional

Website of user

timezone
numberOptional

Timezone offset of user (UTC)

profiles
array[object]Optional

Online profiles for user

type
stringRequired

Profile type (eg: facebook, twitter)

handle
stringOptional

User handle on online platform

url
stringRequired

URL for the profile

employment
objectOptional

Employment information for user

name
stringRequired

Company name

domain
stringOptional

Company domain name

title
stringOptional

User title in company

role
stringOptional

User role in company

seniority
stringOptional

User seniority in company

geolocation
objectOptional

Geolocation information for user

country
stringOptional

Country code (can be blank)

region
stringOptional

Region code (can be blank)

city
stringOptional

City name (can be blank)

coordinates
objectOptional

Location coordinates

latitude
numberRequired

Latitude coordinate

longitude
numberRequired

Longitude coordinate

locales
array[string]Optional

Locales supported by user (ISO 639-1)

company
objectOptional

Company information

name
stringRequired

Company name

legal_name
stringOptional

Company legal name

domain
stringOptional

Company domain name

url
stringOptional

Company website URL

description
stringOptional

Company description

timezone
numberOptional

Company timezone offset (UTC)

phones
array[string]Optional

Company phone numbers

emails
array[string]Optional

Company email addresses

geolocation
objectOptional

Company location

country
stringOptional

Country code (can be blank)

region
stringOptional

Region code (can be blank)

city
stringOptional

City name (can be blank)

coordinates
objectOptional

Location coordinates

latitude
numberRequired

Latitude coordinate

longitude
numberRequired

Longitude coordinate

metrics
objectOptional

Metrics for company

employees
numberOptional

Number of employees

market_cap
numberOptional

Market capitalization

raised
numberOptional

Money raised

arr
numberOptional

Annual Recurring Revenue

tags
array[string]Optional

Tags for company

segments
array[string]Optional

Segments attributed to people profile

notepad
stringOptional

Private notepad on people profile

  • POSThttps://api.crisp.chat/v1/website/website_id/people/profile
  • Tiersuserplugin
  • Scopeswebsite:people:profiles
HTTP
Code
(loading)
Result
(loading)

Check If People Profile Exists

HEAD
/website/{website_id}/people/profile/{people_id}

Checks if given people profile exists.

URI Parameters
website_id
stringRequired

The website identifier

people_id
stringRequired

The people identifier (also allowed: people email)

  • HEADhttps://api.crisp.chat/v1/website/website_id/people/profile/people_id
  • Tiersuserplugin
  • Scopeswebsite:people:profiles
HTTP
Code
(loading)
Result
(loading)

Get People Profile

GET
/website/{website_id}/people/profile/{people_id}

Resolves people profile.

URI Parameters
website_id
stringRequired

The website identifier

people_id
stringRequired

The people identifier (also allowed: people email)

Data Structure
error
boolean
reason
string
data
object
people_id
string

People identifier

email
string

Email for people profile

person
object

Personal information

nickname
string

Nickname for user (includes first name and last name)

avatar
string

Avatar for user

gender
enum[string]

Gender for user

Values

  • male
  • female
phone
string

Phone number for user

address
string

Address for user

description
string

Description for user

website
string

Website of user

timezone
number

Timezone offset of user (UTC)

profiles
array[object]

Online profiles for user

type
string

Profile type (eg: facebook, twitter)

handle
string

User handle on online platform

url
string

URL for the profile

employment
object

Employment information for user

name
string

Company name

domain
string

Company domain name

title
string

User title in company

role
string

User role in company

seniority
string

User seniority in company

geolocation
object

Geolocation information for user

country
string

Country code

region
string

Region code

city
string

City name

coordinates
object

Location coordinates

latitude
number

Latitude coordinate

longitude
number

Longitude coordinate

locales
array[string]

Locales supported by user (ISO 639-1)

company
object

Company information

name
string

Company name

legal_name
string

Company legal name

domain
string

Company domain name

url
string

Company website URL

description
string

Company description

timezone
number

Company timezone offset (UTC)

phones
array[string]

Company phone numbers

emails
array[string]

Company email addresses

geolocation
object

Company location

country
string

Country code

region
string

Region code

city
string

City name

coordinates
object

Location coordinates

latitude
number

Latitude coordinate

longitude
number

Longitude coordinate

metrics
object

Metrics for company

employees
number

Number of employees

market_cap
number

Market capitalization

raised
number

Money raised

arr
number

Annual Recurring Revenue

tags
array[string]

Tags for company

segments
array[string]

Segments attributed to people profile

notepad
string

Private notepad on people profile

active
object

User activity statistics (based on last active session from user)

now
boolean

Whether user is considered active right now or not

last
number

Timestamp at which the user was last active

score
number

Score associated to this profile, from 1 to 5 (based on ratings from user)

created_at
number

Profile creation timestamp

updated_at
number

Profile update timestamp

  • GEThttps://api.crisp.chat/v1/website/website_id/people/profile/people_id
  • Tiersuserplugin
  • Scopeswebsite:people:profiles
HTTP
Code
(loading)
Result
(loading)

Save People Profile

PUT
/website/{website_id}/people/profile/{people_id}

Saves people profile, and overwrite all previous information.

URI Parameters
website_id
stringRequired

The website identifier

people_id
stringRequired

The people identifier (also allowed: people email)

Data Structure
email
stringRequired

Email for people profile

person
objectRequired

Personal information

nickname
stringRequired

Nickname for user (includes first name and last name)

avatar
stringOptional

Avatar for user

gender
enum[string]Optional

Gender for user

Values

  • male
  • female
phone
stringOptional

Phone number for user

address
stringOptional

Address for user

description
stringOptional

Description for user

website
stringOptional

Website of user

timezone
numberOptional

Timezone offset of user (UTC)

profiles
array[object]Optional

Online profiles for user

type
stringRequired

Profile type (eg: facebook, twitter)

handle
stringOptional

User handle on online platform

url
stringRequired

URL for the profile

employment
objectOptional

Employment information for user

name
stringRequired

Company name

domain
stringOptional

Company domain name

title
stringOptional

User title in company

role
stringOptional

User role in company

seniority
stringOptional

User seniority in company

geolocation
objectOptional

Geolocation information for user

country
stringOptional

Country code (can be blank)

region
stringOptional

Region code (can be blank)

city
stringOptional

City name (can be blank)

coordinates
objectOptional

Location coordinates

latitude
numberRequired

Latitude coordinate

longitude
numberRequired

Longitude coordinate

locales
array[string]Optional

Locales supported by user (ISO 639-1)

company
objectOptional

Company information

name
stringRequired

Company name

legal_name
stringOptional

Company legal name

domain
stringOptional

Company domain name

url
stringOptional

Company website URL

description
stringOptional

Company description

timezone
numberOptional

Company timezone offset (UTC)

phones
array[string]Optional

Company phone numbers

emails
array[string]Optional

Company email addresses

geolocation
objectOptional

Company location

country
stringOptional

Country code (can be blank)

region
stringOptional

Region code (can be blank)

city
stringOptional

City name (can be blank)

coordinates
objectOptional

Location coordinates

latitude
numberRequired

Latitude coordinate

longitude
numberRequired

Longitude coordinate

metrics
objectOptional

Metrics for company

employees
numberOptional

Number of employees

market_cap
numberOptional

Market capitalization

raised
numberOptional

Money raised

arr
numberOptional

Annual Recurring Revenue

tags
array[string]Optional

Tags for company

segments
array[string]Optional

Segments attributed to people profile

notepad
stringOptional

Private notepad on people profile

  • PUThttps://api.crisp.chat/v1/website/website_id/people/profile/people_id
  • Tiersuserplugin
  • Scopeswebsite:people:profiles
HTTP
Code
(loading)
Result
(loading)

Update People Profile

PATCH
/website/{website_id}/people/profile/{people_id}

Updates people profile, and save only changed fields on the previous profile revision.

URI Parameters
website_id
stringRequired

The website identifier

people_id
stringRequired

The people identifier (also allowed: people email)

Data Structure
email
stringOptional

Email for people profile

person
objectOptional

Personal information

nickname
stringOptional

Nickname for user (includes first name and last name)

avatar
stringOptional

Avatar for user

gender
enum[string]Optional

Gender for user

Values

  • male
  • female
phone
stringOptional

Phone number for user

address
stringOptional

Address for user

description
stringOptional

Description for user

website
stringOptional

Website of user

timezone
numberOptional

Timezone offset of user (UTC)

profiles
array[object]Optional

Online profiles for user

type
stringOptional

Profile type (eg: facebook, twitter)

handle
stringOptional

User handle on online platform

url
stringOptional

URL for the profile

employment
objectOptional

Employment information for user

name
stringOptional

Company name

domain
stringOptional

Company domain name

title
stringOptional

User title in company

role
stringOptional

User role in company

seniority
stringOptional

User seniority in company

geolocation
objectOptional

Geolocation information for user

country
stringOptional

Country code (can be blank)

region
stringOptional

Region code (can be blank)

city
stringOptional

City name (can be blank)

coordinates
objectOptional

Location coordinates

latitude
numberOptional

Latitude coordinate

longitude
numberOptional

Longitude coordinate

locales
array[string]Optional

Locales supported by user (ISO 639-1)

company
objectOptional

Company information

name
stringOptional

Company name

legal_name
stringOptional

Company legal name

domain
stringOptional

Company domain name

url
stringOptional

Company website URL

description
stringOptional

Company description

timezone
numberOptional

Company timezone offset (UTC)

phones
array[string]Optional

Company phone numbers

emails
array[string]Optional

Company email addresses

geolocation
objectOptional

Company location

country
stringOptional

Country code (can be blank)

region
stringOptional

Region code (can be blank)

city
stringOptional

City name (can be blank)

coordinates
objectOptional

Location coordinates

latitude
numberOptional

Latitude coordinate

longitude
numberOptional

Longitude coordinate

metrics
objectOptional

Metrics for company

employees
numberOptional

Number of employees

market_cap
numberOptional

Market capitalization

raised
numberOptional

Money raised

arr
numberOptional

Annual Recurring Revenue

tags
array[string]Optional

Tags for company

segments
array[string]Optional

Segments attributed to people profile

notepad
stringOptional

Private notepad on people profile

  • PATCHhttps://api.crisp.chat/v1/website/website_id/people/profile/people_id
  • Tiersuserplugin
  • Scopeswebsite:people:profiles
HTTP
Code
(loading)
Result
(loading)

Remove People Profile

DELETE
/website/{website_id}/people/profile/{people_id}

Removes people profile in website.

URI Parameters
website_id
stringRequired

The website identifier

people_id
stringRequired

The people identifier (also allowed: people email)

Data Structure
error
boolean
reason
string
data
object
  • DELETEhttps://api.crisp.chat/v1/website/website_id/people/profile/people_id
  • Tiersuserplugin
  • Scopeswebsite:people:profiles
HTTP
Code
(loading)
Result
(loading)

List People Conversations

GET
/website/{website_id}/people/conversations/{people_id}/list/{page_number}{?filter_unread}{&filter_resolved}{&filter_not_resolved}

Lists conversations linked to people.

URI Parameters
website_id
stringRequired

The website identifier

people_id
stringRequired

The people identifier (also allowed: people email)

page_number
stringOptional

The page number (paging in conversation list)

filter_unread
stringOptional

Whether to return only conversations with unread messages (1 or 0, defaults to 0)

filter_resolved
stringOptional

Whether to return only conversations that are resolved (1 or 0, defaults to 0)

filter_not_resolved
stringOptional

Whether to return only conversations that are not resolved (1 or 0, defaults to 0)

Data Structure
error
boolean
reason
string
data
array[string]
  • GEThttps://api.crisp.chat/v1/website/website_id/people/conversations/people_id/list/page_number
  • Tiersuserplugin
  • Scopeswebsite:people:conversations
HTTP
Code
(loading)
Result
(loading)

List People Campaigns

GET
/website/{website_id}/people/campaigns/{people_id}/list/{page_number}

Lists campaigns linked to people.

URI Parameters
website_id
stringRequired

The website identifier

people_id
stringRequired

The people identifier (also allowed: people email)

page_number
stringOptional

The page number (paging in campaign list)

Data Structure
error
boolean
reason
string
data
array[object]
campaign_id
string

Campaign identifier

type
enum[string]

Campaign type

Values

  • one-shot
  • automated
name
string

Campaign name

created_at
number

Campaign creation timestamp

updated_at
number

Campaign update timestamp

dispatched_at
number

Campaign dispatch timestamp

occurred_at
number

Statistic occurred timestamp

statistics
array[enum[string]]

Statistic points on campaign (ie. actions the user took on campaign)

Values

  • campaign:opened
  • campaign:clicked
  • campaign:unsubscribed
  • GEThttps://api.crisp.chat/v1/website/website_id/people/campaigns/people_id/list/page_number
  • Tiersuser
HTTP
Code
(loading)
Result
(loading)

Add A People Event

POST
/website/{website_id}/people/events/{people_id}

Stacks an event for people.

URI Parameters
website_id
stringRequired

The website identifier

people_id
stringRequired

The people identifier (also allowed: people email)

Data Structure
text
stringRequired

Text for event

data
objectOptional

Data for event (if any)

color
enum[string]Optional

Color for event (if any)

Values

  • red
  • orange
  • yellow
  • green
  • blue
  • purple
  • pink
  • brown
  • grey
  • black
  • POSThttps://api.crisp.chat/v1/website/website_id/people/events/people_id
  • Tiersuserplugin
  • Scopeswebsite:people:events
HTTP
Code
(loading)
Result
(loading)

List People Events

GET
/website/{website_id}/people/events/{people_id}/list/{page_number}

Lists stacked events for people.

URI Parameters
website_id
stringRequired

The website identifier

people_id
stringRequired

The people identifier (also allowed: people email)

page_number
stringOptional

The page number (paging in event list)

Data Structure
error
boolean
reason
string
data
array[object]
text
string

Text for event

data
object

Data for event (if any)

color
enum[string]

Color for event (if any)

Values

  • red
  • orange
  • yellow
  • green
  • blue
  • purple
  • pink
  • brown
  • grey
  • black
timestamp
number

Timestamp of event (when the event was stacked)

  • GEThttps://api.crisp.chat/v1/website/website_id/people/events/people_id/list/page_number
  • Tiersuserplugin
  • Scopeswebsite:people:events
HTTP
Code
(loading)
Result
(loading)

Get People Data

GET
/website/{website_id}/people/data/{people_id}

Gets stored data for people.

URI Parameters
website_id
stringRequired

The website identifier

people_id
stringRequired

The people identifier (also allowed: people email)

Data Structure
error
boolean
reason
string
data
object
data
object

People data

  • GEThttps://api.crisp.chat/v1/website/website_id/people/data/people_id
  • Tiersuserplugin
  • Scopeswebsite:people:data
HTTP
Code
(loading)
Result
(loading)

Save People Data

PUT
/website/{website_id}/people/data/{people_id}

Saves stored data for people.

URI Parameters
website_id
stringRequired

The website identifier

people_id
stringRequired

The people identifier (also allowed: people email)

Data Structure
data
objectOptional

People data

  • PUThttps://api.crisp.chat/v1/website/website_id/people/data/people_id
  • Tiersuserplugin
  • Scopeswebsite:people:data
HTTP
Code
(loading)
Result
(loading)

Get People Subscription Status

GET
/website/{website_id}/people/subscription/{people_id}

Resolves subscription status for people (subscribed or unsubscribed).

URI Parameters
website_id
stringRequired

The website identifier

people_id
stringRequired

The people identifier (also allowed: people email)

Data Structure
error
boolean
reason
string
data
object
email
boolean

Whether people is subscribed to emails or not

  • GEThttps://api.crisp.chat/v1/website/website_id/people/subscription/people_id
  • Tiersuserplugin
  • Scopeswebsite:people:subscriptions
HTTP
Code
(loading)
Result
(loading)

Update People Subscription Status

PATCH
/website/{website_id}/people/subscription/{people_id}

Updates current subscription status for people (subscribe or unsubscribe).

URI Parameters
website_id
stringRequired

The website identifier

people_id
stringRequired

The people identifier (also allowed: people email)

Data Structure
email
booleanRequired

Whether to subscribe to emails or not

  • PATCHhttps://api.crisp.chat/v1/website/website_id/people/subscription/people_id
  • Tiersuserplugin
  • Scopeswebsite:people:subscriptions
HTTP
Code
(loading)
Result
(loading)

Export People Profiles

POST
/website/{website_id}/people/export/profiles

Exports people profiles. The exported data is sent back to email to the requester user.

URI Parameters
website_id
stringRequired

The website identifier

Data Structure
error
boolean
reason
string
data
object
  • POSThttps://api.crisp.chat/v1/website/website_id/people/export/profiles
  • Tiersuser
HTTP
Code
(loading)
Result
(loading)

Import People Profiles

POST
/website/{website_id}/people/import/profiles

Imports people profiles. The imported data, eg. a CSV file containing user emails and full names is used to populate website user database.

The import events are sent back asynchronously on the RTM Events channel, using either the event namespace people:import:progress or people:import:done.

URI Parameters
website_id
stringRequired

The website identifier

Data Structure
url
stringRequired

File URL containing user data to be imported

mapping
array[object]Required

Raw data to Crisp data mapping

column
numberRequired

Mapping from raw data column index (starts at 1)

field
enum[string]Required

Mapping to Crisp field (regular field, or virtual field starting with _.)

Values

  • email
  • segments
  • notepad
  • person.nickname
  • person.phone
  • person.address
  • person.website
  • person.geolocation.country
  • person.geolocation.city
  • company.name
  • data.[*]
  • created_at
  • active
  • _.person.first_name
  • _.person.last_name
  • _.unsubscribed
options
objectRequired

Import options

column_separator
stringRequired

One-character column separator

skip_header
booleanRequired

Whether to skip headers or not

  • POSThttps://api.crisp.chat/v1/website/website_id/people/import/profiles
  • Tiersuser
HTTP
Code
(loading)
Result
(loading)

Visitorsin Website

Count Visitors

GET
/website/{website_id}/visitors/count

Counts visitors currently on website.

URI Parameters
website_id
stringRequired

The website identifier

Data Structure
error
boolean
reason
string
data
object
count
number

Number of visitors currently on website

active
number

Number of active visitors currently on website (those actively browsing)

limited
boolean

Whether visitor sockets are limited or not (due to high traffic)

  • GEThttps://api.crisp.chat/v1/website/website_id/visitors/count
  • Tiersuserplugin
  • Scopeswebsite:visitors
HTTP
Code
(loading)
Result
(loading)

List Visitors

GET
/website/{website_id}/visitors/list/{page_number}

Lists visitors currently on website.

URI Parameters
website_id
stringRequired

The website identifier

page_number
stringOptional

Page number for conversations paging

Data Structure
error
boolean
reason
string
data
array[object]
session_id
string

Session identifier for visitor

nickname
string

Nickname for visitor

email
string

Email for visitor

avatar
string

Avatar for visitor

useragent
string

Useragent as advertised by visitor browser

initiated
boolean

Whether session is initiated or not

active
boolean

Whether the user is actively browsing or not

last_page
object

Last page browsed by visitor

page_title
string

Last page title

page_url
string

Last page URL

geolocation
object

Geolocation for visitor

country
string

Country code

region
string

Region code

city
string

City name

coordinates
object

Location coordinates

latitude
number

Latitude coordinate

longitude
number

Longitude coordinate

timezone
number

Visitor timezone offset (UTC)

capabilities
array[enum[string]]

Capabilities of the visitor device

Values

  • browsing
  • call
locales
array[string]

Locales supported by visitor (ISO 639-1)

  • GEThttps://api.crisp.chat/v1/website/website_id/visitors/list/page_number
  • Tiersuserplugin
  • Scopeswebsite:visitors
HTTP
Code
(loading)
Result
(loading)

Pinpoint Visitors On A Map

GET
/website/{website_id}/visitors/map{?center_latitude}{&center_longitude}{&center_radius}

Maps visitors in a geographical area, given a geographical center and a map radius (defaults to whole Earth if none given). Visitors are grouped in geographical points. There is a static number of points per area (the area is composed of sub-divisions of equal size). Only points which contain visitors are returned.

The map precision increases as the area radius decreases. If there are too many visitors in a given geographical point, an approximate visitors count number will be given.

URI Parameters
website_id
stringRequired

The website identifier

center_latitude
stringOptional

Area center point latitude

center_longitude
stringOptional

Area center point longitude

center_radius
stringOptional

Area radius (in kilometers)

Data Structure
error
boolean
reason
string
data
object
visitors
object

Visitors for geographical point

count
number

Number of visitors in geographical point

threshold
number

The maximum count number as restricted by the API for calculations (may vary)

sessions
array[object]

Sessions associated to the geographical point

session_id
string

Session identifier for session

nickname
string

Nickname for session

email
string

Email for session

avatar
string

Avatar for session

initiated
boolean

Whether session is initiated or not

active
boolean

Whether the user is actively browsing or not

last_page
object

Last page browsed by session

page_title
string

Last page title

page_url
string

Last page URL

timezone
number

Visitor timezone offset (UTC)

capabilities
array[enum[string]]

Capabilities of the visitor device

Values

  • browsing
  • call
locales
array[string]

Locales supported by visitor (ISO 639-1)

geolocation
object

Geolocation for geographical point

country
string

Country code

region
string

Region code

city
string

City name

coordinates
object

Location coordinates

latitude
number

Latitude coordinate

longitude
number

Longitude coordinate

  • GEThttps://api.crisp.chat/v1/website/website_id/visitors/map
  • Tiersuserplugin
  • Scopeswebsite:visitors
HTTP
Code
(loading)
Result
(loading)

Get Session Identifier From Token

GET
/website/{website_id}/visitors/token/{token_id}

Transforms a token to a session identifier, if any session is bound to the token. The token can be bound to a session from the Crisp chatbox.

URI Parameters
website_id
stringRequired

The website identifier

token_id
stringRequired

The token identifier

Data Structure
error
boolean
reason
string
data
array[object]
session_id
string

Session identifier

token_id
string

Token value

  • GEThttps://api.crisp.chat/v1/website/website_id/visitors/token/token_id
  • Tiersuserplugin
  • Scopeswebsite:visitors
HTTP
Code
(loading)
Result
(loading)

Count Blocked Visitors

GET
/website/{website_id}/visitors/blocked

Counts all blocked visitors on website, by rule list.

URI Parameters
website_id
stringRequired

The website identifier

Data Structure
error
boolean
reason
string
data
array[object]
rule
enum[string]

Rule name

Values

  • ip
  • email
blocked
number

Number of blocked visitors for rule

  • GEThttps://api.crisp.chat/v1/website/website_id/visitors/blocked
  • Tiersuser
HTTP
Code
(loading)
Result
(loading)

Count Blocked Visitors In Rule

GET
/website/{website_id}/visitors/blocked/{block_rule}

Counts all blocked visitors in rule list on website.

URI Parameters
website_id
stringRequired

The website identifier

block_rule
stringRequired

The block rule (ip or email)

Data Structure
error
boolean
reason
string
data
object
rule
enum[string]

Rule name

Values

  • ip
  • email
blocked
number

Number of blocked visitors for rule

  • GEThttps://api.crisp.chat/v1/website/website_id/visitors/blocked/block_rule
  • Tiersuser
HTTP
Code
(loading)
Result
(loading)

Clear Blocked Visitors In Rule

DELETE
/website/{website_id}/visitors/blocked/{block_rule}

Clears all blocked visitors in rule list on website.

URI Parameters
website_id
stringRequired

The website identifier

block_rule
stringRequired

The block rule (ip or email)

Data Structure
error
boolean
reason
string
data
object
  • DELETEhttps://api.crisp.chat/v1/website/website_id/visitors/blocked/block_rule
  • Tiersuser
HTTP
Code
(loading)
Result
(loading)

Availabilityin Website

Get Website Availability Status

GET
/website/{website_id}/availability/status

Resolves the website availability status. This tells whether the chatbox is seen as online or away by visitors.

The availability status is set to online if at least one operator can be seen as online (given his account availability settings).

URI Parameters
website_id
stringRequired

The website identifier

Data Structure
error
boolean
reason
string
data
object
status
enum[string]

Availability status

Values

  • online
  • away
  • offline
since
number

Timestamp since when the availability has been updated

  • GEThttps://api.crisp.chat/v1/website/website_id/availability/status
  • Tiersuserplugin
  • Scopeswebsite:availability
HTTP
Code
(loading)
Result
(loading)

List Website Operator Availabilities

GET
/website/{website_id}/availability/operators

Lists the availabilities for website operators. This maps the availability of each operator in the website.

URI Parameters
website_id
stringRequired

The website identifier

Data Structure
error
boolean
reason
string
data
array[object]
user_id
string

User identifier

type
enum[string]

Availability type

Values

  • online
  • away
  • offline
time
object
for
number

Seconds for which the availability is valid

since
number

Timestamp since when the availability has been updated

  • GEThttps://api.crisp.chat/v1/website/website_id/availability/operators
  • Tiersuserplugin
  • Scopeswebsite:availability
HTTP
Code
(loading)
Result
(loading)

Operatorsin Website

List Website Operators

GET
/website/{website_id}/operators/list

Lists all operator members of website.

URI Parameters
website_id
stringRequired

The website identifier

Data Structure
error
boolean
reason
string
data
array[object]
type
enum[string]

Member type

Values

  • operator
  • invite
  • sandbox
details
object

Member details

user_id
string

User identifier (for operator and sandbox types only)

email
string

User email (for all types)

avatar
string

User avatar (for operator type only)

first_name
string

User first name (for operator and sandbox types only)

last_name
string

User last name (for operator and sandbox types only)

role
enum[string]

User role (for operator and invite types only)

Values

  • owner
  • member
title
string

User title (if any, for operator type only)

availability
enum[string]

User availability (for operator type only)

Values

  • online
  • away
  • offline
has_token
boolean

Whether operator has Two Factor Authentication enabled or not (for operator type only)

identifier
string

User invite identifier (for invite type only)

key
string

User invite key (for invite type only)

  • GEThttps://api.crisp.chat/v1/website/website_id/operators/list
  • Tiersuserplugin
  • Scopeswebsite:operators
HTTP
Code
(loading)
Result
(loading)

List Last Active Website Operators

GET
/website/{website_id}/operators/active

Lists last active website operators, ie. operators who last replied to a visitor message.

URI Parameters
website_id
stringRequired

The website identifier

Data Structure
error
boolean
reason
string
data
array[object]
user_id
string

Operator user identifier

avatar
string

Operator avatar

nickname
string

Operator nickname

timestamp
number

Timestamp at which operator was last active

  • GEThttps://api.crisp.chat/v1/website/website_id/operators/active
  • Tiersuserplugin
  • Scopeswebsite:operators
HTTP
Code
(loading)
Result
(loading)

Flush Last Active Website Operators

DELETE
/website/{website_id}/operators/active

Flushes the list of last active website operators, ie. operators who last replied to a visitor message.

URI Parameters
website_id
stringRequired

The website identifier

Data Structure
error
boolean
reason
string
data
object
  • DELETEhttps://api.crisp.chat/v1/website/website_id/operators/active
  • Tiersuser
HTTP
Code
(loading)
Result
(loading)

Send Email To Website Operators

PATCH
/website/{website_id}/operators/email

Sends an email to target website operators. The email will be delivered to each operator account email address.

URI Parameters
website_id
stringRequired

The website identifier

Data Structure
recipient
enum[string]Required

Recipient type

Values

  • all
  • owners
  • members
  • user
user_id
stringOptional

Recipient user identifier (if recipient is user)

subject
stringRequired

Email subject

message
stringRequired

Email message body

target
objectOptional

Target button

label
stringRequired

Target button label

url
stringRequired

Target button URL

  • PATCHhttps://api.crisp.chat/v1/website/website_id/operators/email
  • Tiersuserplugin
  • Scopeswebsite:operators
HTTP
Code
(loading)
Result
(loading)

Operatorin Website

Get A Website Operator

GET
/website/{website_id}/operator/{user_id}

Resolves a given website operator.

URI Parameters
website_id
stringRequired

The website identifier

user_id
stringRequired

The user identifier for operator

Data Structure
error
boolean
reason
string
data
object
user_id
string

User identifier

email
string

User email

avatar
string

User avatar

first_name
string

User first name

last_name
string

User last name

role
enum[string]

User role

Values

  • owner
  • member
title
string

User title (if any)

availability
enum[string]

User availability

Values

  • online
  • away
  • offline
has_token
boolean

Whether operator has Two Factor Authentication enabled or not

  • GEThttps://api.crisp.chat/v1/website/website_id/operator/user_id
  • Tiersuserplugin
  • Scopeswebsite:operators
HTTP
Code
(loading)
Result
(loading)

Invite A Website Operator

POST
/website/{website_id}/operator

Invites an email to join website as operator. The target email doesn't need to be a valid Crisp account, since Crisp will send an invite email to that email. The receiver is then prompted to click on a link to either join the website with an existing account, or create a new account on the fly.

URI Parameters
website_id
stringRequired

The website identifier

Data Structure
email
stringRequired

Operator email

role
enum[string]Required

Operator role

Values

  • owner
  • member
verify
stringRequired

User password (used to double-authenticate invite)

  • POSThttps://api.crisp.chat/v1/website/website_id/operator
  • Tiersuser
HTTP
Code
(loading)
Result
(loading)

Change Operator Membership

PATCH
/website/{website_id}/operator/{user_id}

Changes the membership of an existing operator. Useful to downgrade or upgrade an operator from/to owner role, or change their title in the team.

URI Parameters
website_id
stringRequired

The website identifier

user_id
stringRequired

The user identifier for operator

Data Structure
role
enum[string]Optional

Operator role

Values

  • owner
  • member
title
stringOptional

Operator title (if any)

  • PATCHhttps://api.crisp.chat/v1/website/website_id/operator/user_id
  • Tiersuser
HTTP
Code
(loading)
Result
(loading)
DELETE
/website/{website_id}/operator/{user_id}

Unlinks given operator from website. Note that the last operator in the website cannot be unlinked.

URI Parameters
website_id
stringRequired

The website identifier

user_id
stringRequired

The user identifier for operator

Data Structure
error
boolean
reason
string
data
object
  • DELETEhttps://api.crisp.chat/v1/website/website_id/operator/user_id
  • Tiersuser
HTTP
Code
(loading)
Result
(loading)

Campaignsin Website

List Campaigns

GET
/website/{website_id}/campaigns/list/{page_number}{?search_name}{&filter_tag}{&filter_type_one_shot}{&filter_type_automated}{&filter_status_not_configured}{&filter_status_ready}{&filter_status_paused}{&filter_status_sending}{&filter_status_done}

Lists campaigns for website.

URI Parameters
website_id
stringRequired

The website identifier

page_number
stringOptional

Page number for campaigns paging

search_name
stringOptional

Search by campaign name

filter_tag
stringOptional

Filter by campaign tag

filter_type_one_shot
stringOptional

Filter by campaign one-shot type (1 or 0)

filter_type_automated
stringOptional

Filter by campaign automated type (1 or 0)

filter_status_not_configured
stringOptional

Filter by campaign not configured status (1 or 0)

filter_status_ready
stringOptional

Filter by campaign ready status (1 or 0)

filter_status_paused
stringOptional

Filter by campaign paused status (1 or 0)

filter_status_sending
stringOptional

Filter by campaign sending status (1 or 0)

filter_status_done
stringOptional

Filter by campaign done status (1 or 0)

Data Structure
error
boolean
reason
string
data
array[object]
campaign_id
string

Campaign identifier

type
enum[string]

Campaign type

Values

  • one-shot
  • automated
format
enum[string]

Campaign format

Values

  • markdown
  • html
name
string

Campaign name

subject
string

Campaign subject

tag
string

Campaign tag (if any)

ready
boolean

Campaign ready state

dispatched
boolean

Campaign dispatched state

running
boolean

Campaign running state

progress
number

Campaign progress percentage (from 0 to 100)

targets
number

Number of targets (number of users the campaign reaches)

reached
number

Number of reached users (number of users who received the campaign message)

created_at
number

Campaign creation timestamp

updated_at
number

Campaign update timestamp

dispatched_at
number

Campaign dispatch timestamp

  • GEThttps://api.crisp.chat/v1/website/website_id/campaigns/list/page_number
  • Tiersuser
HTTP
Code
(loading)
Result
(loading)

List Campaign Tags

GET
/website/{website_id}/campaigns/tags

Lists campaign tags for website.

URI Parameters
website_id
stringRequired

The website identifier

Data Structure
error
boolean
reason
string
data
array[string]

Campaign tags

  • GEThttps://api.crisp.chat/v1/website/website_id/campaigns/tags
  • Tiersuser
HTTP
Code
(loading)
Result
(loading)

List Campaign Templates

GET
/website/{website_id}/campaigns/templates/{page_number}{?search_name}{&filter_type_static}{&filter_type_custom}

Lists campaign templates for website.

URI Parameters
website_id
stringRequired

The website identifier

page_number
stringOptional

Page number for templates paging

search_name
stringOptional

Search by template name

filter_type_static
stringOptional

Filter by template static type (1 or 0)

filter_type_custom
stringOptional

Filter by template custom type (1 or 0)

Data Structure
error
boolean
reason
string
data
array[object]
template_id
string

Template identifier

type
enum[string]

Template type

Values

  • static
  • custom
name
string

Template name

format
enum[string]

Template format

Values

  • markdown
  • html
created_at
number

Template creation timestamp

updated_at
number

Template update timestamp

  • GEThttps://api.crisp.chat/v1/website/website_id/campaigns/templates/page_number
  • Tiersuser
HTTP
Code
(loading)
Result
(loading)

Create A New Campaign Template

POST
/website/{website_id}/campaigns/template

Creates a new campaign template.

URI Parameters
website_id
stringRequired

The website identifier

Data Structure
name
stringRequired

Template name

format
enum[string]Required

Template format

Values

  • markdown
  • html
  • POSThttps://api.crisp.chat/v1/website/website_id/campaigns/template
  • Tiersuser
HTTP
Code
(loading)
Result
(loading)

Check If Campaign Template Exists

HEAD
/website/{website_id}/campaigns/template/{template_id}

Checks if given campaign template exists.

URI Parameters
website_id
stringRequired

The website identifier

template_id
stringRequired

The template identifier

  • HEADhttps://api.crisp.chat/v1/website/website_id/campaigns/template/template_id
  • Tiersuser
HTTP
Code
(loading)
Result
(loading)

Get A Campaign Template

GET
/website/{website_id}/campaigns/template/{template_id}

Resolves campaign template information.

URI Parameters
website_id
stringRequired

The website identifier

template_id
stringRequired

The template identifier

Data Structure
error
boolean
reason
string
data
object
template_id
string

Template identifier

type
enum[string]

Template type

Values

  • static
  • custom
name
string

Template name

format
enum[string]

Template format

Values

  • markdown
  • html
content
string

Template content

created_at
number

Template creation timestamp

updated_at
number

Template update timestamp

  • GEThttps://api.crisp.chat/v1/website/website_id/campaigns/template/template_id
  • Tiersuser
HTTP
Code
(loading)
Result
(loading)

Save A Campaign Template

PUT
/website/{website_id}/campaigns/template/{template_id}

Saves a campaign template in website, and overwrite previous template information.

URI Parameters
website_id
stringRequired

The website identifier

template_id
stringRequired

The template identifier

Data Structure
name
stringRequired

Template name

format
enum[string]Required

Template format

Values

  • markdown
  • html
content
stringRequired

Template content

  • PUThttps://api.crisp.chat/v1/website/website_id/campaigns/template/template_id
  • Tiersuser
HTTP
Code
(loading)
Result
(loading)

Update A Campaign Template

PATCH
/website/{website_id}/campaigns/template/{template_id}

Updates a campaign template in website, and save only changed fields.

URI Parameters
website_id
stringRequired

The website identifier

template_id
stringRequired

The template identifier

Data Structure
name
stringOptional

Template name

format
enum[string]Optional

Template format

Values

  • markdown
  • html
content
stringOptional

Template content

  • PATCHhttps://api.crisp.chat/v1/website/website_id/campaigns/template/template_id
  • Tiersuser
HTTP
Code
(loading)
Result
(loading)

Remove A Campaign Template

DELETE
/website/{website_id}/campaigns/template/{template_id}

Removes a campaign template in website.

URI Parameters
website_id
stringRequired

The website identifier

template_id
stringRequired

The template identifier

Data Structure
error
boolean
reason
string
data
object
  • DELETEhttps://api.crisp.chat/v1/website/website_id/campaigns/template/template_id
  • Tiersuser
HTTP
Code
(loading)
Result
(loading)

Campaignin Website

Create A New Campaign

POST
/website/{website_id}/campaign

Creates a new campaign.

URI Parameters
website_id
stringRequired

The website identifier

Data Structure
type
enum[string]Required

Campaign type

Values

  • one-shot
  • automated
name
stringRequired

Campaign name

  • POSThttps://api.crisp.chat/v1/website/website_id/campaign
  • Tiersuser
HTTP
Code
(loading)
Result
(loading)

Check If Campaign Exists

HEAD
/website/{website_id}/campaign/{campaign_id}

Checks if given campaign exists.

URI Parameters
website_id
stringRequired

The website identifier

campaign_id
stringRequired

The campaign identifier

  • HEADhttps://api.crisp.chat/v1/website/website_id/campaign/campaign_id
  • Tiersuser
HTTP
Code
(loading)
Result
(loading)

Get A Campaign

GET
/website/{website_id}/campaign/{campaign_id}

Resolves campaign information.

URI Parameters
website_id
stringRequired

The website identifier

campaign_id
stringRequired

The campaign identifier

Data Structure
error
boolean
reason
string
data
object
campaign_id
string

Campaign identifier

type
enum[string]

Campaign type

Values

  • one-shot
  • automated
format
enum[string]

Campaign format

Values

  • markdown
  • html
name
string

Campaign name

subject
string

Campaign subject

tag
string

Campaign tag (if any)

sender
object

Campaign sender

user_id
string

Sender user identifier (member of website)

recipients
object

Campaign recipients (if type is one-shot)

type
enum[string]

Recipient routing type

Values

  • all
  • segment
  • people
  • filter
segments
array[string]

Routing segments (if type is segment)

people
array[string]

Routing people (if type is people)

filter
array[object]

Routing filter (if type is filter)

model
enum[string]

Filter model

Values

  • people
criterion
string

Filter criterion (in model)

operator
enum[string]

Filter operator

Values

  • eq
  • neq
  • ex
  • nex
  • has
  • nhas
  • sw
  • ew
  • gte
  • lte
  • gt
  • lt
query
array[string]

Filter query terms

flow
object

Campaign flow (if type is automated)

launch_event
string

Event identifier that triggers automation flow (to run campaign for an user)

assert_filter
array[object]

Filter to assert when event is triggered (can be empty)

model
enum[string]

Filter model

Values

  • people
criterion
string

Filter criterion (in model)

operator
enum[string]

Filter operator

Values

  • eq
  • neq
  • ex
  • nex
  • has
  • nhas
  • sw
  • ew
  • gte
  • lte
  • gt
  • lt
query
array[string]

Filter query terms

assert_delay
number

Delay in minutes after which to process assertions (no delay by default)

deliver_once
boolean

Ensures campaign is delivered once at a maximum for a given user, or not

deliver_delay
number

Delivery delay in minutes (no delay by default)

message
string

Campaign message

options
object

Campaign options

deliver_to_chatbox
boolean

Whether to deliver message to chatbox or not

deliver_to_email
boolean

Whether to deliver message to email or not

sender_name_website
boolean

Whether to append website name after email sender name or not

sender_email_reply
boolean

Email address to use as a reply-to address for email campaigns

tracking
boolean

Whether to enable tracking or not

statistics
object

Campaign statistics

opened
number

Number of recipients who opened the campaign email

clicked
number

Number of recipients who clicked on a link in the campaign email

unsubscribed
number

Number of recipients who unsubscribed from the campaign email

ready
boolean

Campaign ready state

dispatched
boolean

Campaign dispatched state

running
boolean

Campaign running state

progress
number

Campaign progress percentage (from 0 to 100)

targets
number

Number of targets (number of users the campaign reaches)

reached
number

Number of reached users (number of users who received the campaign message)

created_at
number

Campaign creation timestamp

updated_at
number

Campaign update timestamp

dispatched_at
number

Campaign dispatch timestamp

  • GEThttps://api.crisp.chat/v1/website/website_id/campaign/campaign_id
  • Tiersuser
HTTP
Code
(loading)
Result
(loading)

Save A Campaign

PUT
/website/{website_id}/campaign/{campaign_id}

Saves a campaign in website, and overwrite previous campaign information.

URI Parameters
website_id
stringRequired

The website identifier

campaign_id
stringRequired

The campaign identifier

Data Structure
type
enum[string]Required

Campaign type

Values

  • one-shot
  • automated
format
enum[string]Required

Campaign format

Values

  • markdown
  • html
name
stringRequired

Campaign name

subject
stringRequired

Campaign subject

tag
stringOptional

Campaign tag (can be empty)

sender
objectRequired

Campaign sender

user_id
stringRequired

Sender user identifier (member of website)

recipients
objectRequired

Campaign recipients (if type is one-shot)

type
enum[string]Required

Recipient routing type

Values

  • all
  • segment
  • people
  • filter
segments
array[string]Optional

Routing segments (if type is segment)

people
array[string]Optional

Routing people (if type is people)

filter
array[object]Optional

Routing filter (if type is filter)

model
enum[string]Required

Filter model

Values

  • people
criterion
stringRequired

Filter criterion (in model)

operator
enum[string]Required

Filter operator

Values

  • eq
  • neq
  • ex
  • nex
  • has
  • nhas
  • sw
  • ew
  • gte
  • lte
  • gt
  • lt
query
array[string]Required

Filter query terms

flow
objectRequired

Campaign flow (if type is automated)

launch_event
stringRequired

Event identifier that triggers automation flow (to run campaign for an user)

assert_filter
array[object]Required

Filter to assert when event is triggered (can be empty)

model
enum[string]Required

Filter model

Values

  • people
criterion
stringRequired

Filter criterion (in model)

operator
enum[string]Required

Filter operator

Values

  • eq
  • neq
  • ex
  • nex
  • has
  • nhas
  • sw
  • ew
  • gte
  • lte
  • gt
  • lt
query
array[string]Required

Filter query terms

assert_delay
numberRequired

Delay in minutes after which to process assertions (no delay by default)

deliver_once
booleanRequired

Ensures campaign is delivered once at a maximum for a given user, or not

deliver_delay
numberRequired

Delivery delay in minutes (no delay by default)

message
stringRequired

Campaign message

options
objectOptional

Campaign options

deliver_to_chatbox
booleanRequired

Whether to deliver message to chatbox or not

deliver_to_email
booleanRequired

Whether to deliver message to email or not

sender_name_website
booleanRequired

Whether to append website name after email sender name or not

sender_email_reply
booleanRequired

Email address to use as a reply-to address for email campaigns

tracking
booleanRequired

Whether to enable tracking or not

  • PUThttps://api.crisp.chat/v1/website/website_id/campaign/campaign_id
  • Tiersuser
HTTP
Code
(loading)
Result
(loading)

Update A Campaign

PATCH
/website/{website_id}/campaign/{campaign_id}

Updates a campaign in website, and save only changed fields.

URI Parameters
website_id
stringRequired

The website identifier

campaign_id
stringRequired

The campaign identifier

Data Structure
type
enum[string]Optional

Campaign type

Values

  • one-shot
  • automated
format
enum[string]Optional

Campaign format

Values

  • markdown
  • html
name
stringOptional

Campaign name

subject
stringOptional

Campaign subject

tag
stringOptional

Campaign tag (can be empty)

sender
objectOptional

Campaign sender

user_id
stringRequired

Sender user identifier (member of website)

recipients
objectOptional

Campaign recipients (if type is one-shot)

type
enum[string]Required

Recipient routing type

Values

  • all
  • segment
  • people
  • filter
segments
array[string]Optional

Routing segments (if type is segment)

people
array[string]Optional

Routing people (if type is people)

filter
array[object]Optional

Routing filter (if type is filter)

model
enum[string]Required

Filter model

Values

  • people
criterion
stringRequired

Filter criterion (in model)

operator
enum[string]Required

Filter operator

Values

  • eq
  • neq
  • ex
  • nex
  • has
  • nhas
  • sw
  • ew
  • gte
  • lte
  • gt
  • lt
query
array[string]Required

Filter query terms

flow
objectOptional

Campaign flow (if type is automated)

launch_event
stringRequired

Event identifier that triggers automation flow (to run campaign for an user)

assert_filter
array[object]Required

Filter to assert when event is triggered (can be empty)

model
enum[string]Required

Filter model

Values

  • people
criterion
stringRequired

Filter criterion (in model)

operator
enum[string]Required

Filter operator

Values

  • eq
  • neq
  • ex
  • nex
  • has
  • nhas
  • sw
  • ew
  • gte
  • lte
  • gt
  • lt
query
array[string]Required

Filter query terms

assert_delay
numberRequired

Delay in minutes after which to process assertions (no delay by default)

deliver_once
booleanRequired

Ensures campaign is delivered once at a maximum for a given user, or not

deliver_delay
numberRequired

Delivery delay in minutes (no delay by default)

message
stringOptional

Campaign message

options
objectOptional

Campaign options

deliver_to_chatbox
booleanRequired

Whether to deliver message to chatbox or not

deliver_to_email
booleanRequired

Whether to deliver message to email or not

sender_name_website
booleanRequired

Whether to append website name after email sender name or not

sender_email_reply
booleanRequired

Email address to use as a reply-to address for email campaigns

tracking
booleanRequired

Whether to enable tracking or not

  • PATCHhttps://api.crisp.chat/v1/website/website_id/campaign/campaign_id
  • Tiersuser
HTTP
Code
(loading)
Result
(loading)

Remove A Campaign

DELETE
/website/{website_id}/campaign/{campaign_id}

Removes a campaign in website.

URI Parameters
website_id
stringRequired

The website identifier

campaign_id
stringRequired

The campaign identifier

Data Structure
error
boolean
reason
string
data
object
  • DELETEhttps://api.crisp.chat/v1/website/website_id/campaign/campaign_id
  • Tiersuser
HTTP
Code
(loading)
Result
(loading)

Dispatch A Campaign

POST
/website/{website_id}/campaign/{campaign_id}/dispatch

Dispatches a ready campaign.

URI Parameters
website_id
stringRequired

The website identifier

campaign_id
stringRequired

The campaign identifier

Data Structure
error
boolean
reason
string
data
object
  • POSThttps://api.crisp.chat/v1/website/website_id/campaign/campaign_id/dispatch
  • Tiersuser
HTTP
Code
(loading)
Result
(loading)

Resume A Campaign

POST
/website/{website_id}/campaign/{campaign_id}/resume

Resumes a paused and dispatched campaign.

URI Parameters
website_id
stringRequired

The website identifier

campaign_id
stringRequired

The campaign identifier

Data Structure
error
boolean
reason
string
data
object
  • POSThttps://api.crisp.chat/v1/website/website_id/campaign/campaign_id/resume
  • Tiersuser