Crisp REST API Reference (V1)

Get A Website Delete A Website Create Website Abort Website Deletion Check If Website Exists

Website-Conversations

Delete Suggested Conversation Segment List Suggested Conversation Data Keys Submit Spam Conversation Decision Resolve Spam Conversation Content List Spam Conversations List Suggested Conversation Segments Delete Suggested Conversation Data Key ⭐ List Conversations

Website-Conversation

Initiate A Conversation With Existing Session Deliver Widget Button Action For Conversation Request Email Transcript For Conversation List Conversation Files Get Verify Status For Conversation ⭐ Get Conversation Metas ⭐ Change Conversation State Request Chatbox Binding Purge For Conversation Remove A Conversation ⭐ Send A Message In Conversation Save Conversation Participants Remove A Message In Conversation List Browsing Sessions For Conversation Update Conversation Open State Assist An Existing Browsing Session ⭐ Get Messages In Conversation Send Action To An Existing Browsing Session Compose A Message In Conversation Get Block Status For Conversation ⭐ Update Conversation Metas Get Conversation State ⭐ Mark Messages As Read In Conversation Request User Feedback For Conversation Check If Conversation Exists Update Verify Status For Conversation Get Conversation Participants ⭐ Mark Messages As Delivered In Conversation ⭐ Assign Conversation Routing Update Conversation Inbox Block Incoming Messages For Conversation List Conversation Events ⭐ Get A Conversation Deliver Widget Data Action For Conversation ⭐ Get Conversation Routing Assign Get A Message In Conversation Get An Original Message In Conversation ⭐ Create A New Conversation Get Ongoing Call Session For Conversation Initiate New Call Session For Conversation Abort Ongoing Call Session For Conversation Update A Message In Conversation Initiate Browsing Session For Conversation List Conversation Pages Transmit Signaling On Ongoing Call Session Schedule A Reminder For Conversation

List People Conversations List Suggested People Events Import People Profiles ⭐ Check If People Profile Exists Add A People Event ⭐ Save People Profile Get People Data ⭐ Get People Profile List Suggested People Data Keys ⭐ List People Profiles ⭐ Update People Profile Delete Suggested People Segment List People Events Delete Suggested People Event Update People Subscription Status ⭐ Remove People Profile Export People Profiles List Suggested People Segments ⭐ Add New People Profile Delete Suggested People Data Key Get People Subscription Status Save People Data List People Campaigns Update People Data Get People Statistics

Website-Visitors

Pinpoint Visitors On A Map List Visitors Clear Blocked Visitors In Rule Count Visitors Count Blocked Visitors In Rule Count Blocked Visitors Get Session Identifier From Token

Website-Availability

List Website Operator Availabilities Get Website Availability Status

Website-Operators

List Last Active Website Operators Flush Last Active Website Operators Send Email To Website Operators List Website Operators

Website-Operator

Get A Website Operator Invite A Website Operator Unlink Operator From Website Change Operator Membership

Website-Helpdesk

Resolve Helpdesk Locale Article List Helpdesk Locales Resolve Helpdesk Locale Article Category Resolve Helpdesk Save Helpdesk Locale Section Check If Helpdesk Locale Exists Delete Helpdesk Redirection Add Helpdesk Locale Resolve Helpdesk Locale Unpublish Helpdesk Locale Article Update Helpdesk Locale Section List Helpdesk Locale Article Alternates Update Helpdesk Locale Article Category Check If Helpdesk Locale Article Alternate Exists List Helpdesk Locale Categories Resolve Helpdesk Locale Article Page Update Helpdesk Locale Category Resolve Helpdesk Domain Delete Helpdesk Locale Article Alternate Delete Helpdesk Locale Article Map Helpdesk Locale Feedback Ratings Delete Helpdesk Locale Section Delete Helpdesk Locale List Helpdesk Locale Sections Resolve Helpdesk Locale Section Add Helpdesk Locale Section Check If Helpdesk Exists Save Helpdesk Locale Category Save Helpdesk Settings List Helpdesk Locale Feedbacks Save Helpdesk Locale Article Add Helpdesk Redirection Request Helpdesk Domain Change Resolve Helpdesk Locale Article Alternate Publish Helpdesk Locale Article Save Helpdesk Locale Article Alternate Check If Helpdesk Redirection Exists Resolve Helpdesk Settings List Helpdesk Locale Articles Initialize Helpdesk Generate Helpdesk Domain Setup Flow Resolve Helpdesk Locale Category List Helpdesk Redirections Delete Helpdesk Locale Category Add Helpdesk Locale Category Check If Helpdesk Locale Section Exists Delete Helpdesk Add A New Helpdesk Locale Article Update Helpdesk Locale Article Check If Helpdesk Locale Article Exists Check If Helpdesk Locale Category Exists Resolve Helpdesk Redirection Import External Helpdesk To Locale Export Helpdesk Locale Articles

Website-Campaigns

Save A Campaign Template Check If Campaign Template Exists Get A Campaign Template Create A New Campaign Template Update A Campaign Template List Campaign Tags List Campaign Templates List Campaigns Remove A Campaign Template

Website-Campaign

Pause A Campaign List Campaign Statistics Remove A Campaign Create A New Campaign Test A Campaign Resume A Campaign Check If Campaign Exists Save A Campaign List Campaign Recipients Dispatch A Campaign Get A Campaign Update A Campaign

Website-Analytics

Generate Analytics

Batch Resolve Items Batch Read Items Batch Remove Items

Website-Settings

Get Website Settings Update Website Settings

Get Verify Settings Get Verify Key Update Verify Settings Roll Verify Key

Plugin-Subscription

Get Subscription Details Report Plugin Usage To Bill Update Subscription Settings Get Subscription Settings Subscribe Website To Plugin Dispatch Plugin Event List All Active Subscriptions Forward Plugin Payload To Channel Get Plugin Usage Bills List Subscriptions For A Website Unsubscribe Plugin From Website Save Subscription Settings

Plugin-Connect Account

⭐ Get Connect Account

Plugin-Connect Session

⭐ Check Connect Session Validity

Plugin-Connect Websites

List Connect Websites Since ⭐ List All Connect Websites

Plugin-Connect Endpoints

⭐ Get Connect Endpoints

Generate Bucket URL

Media-Animation

List Animation Medias

Crisp REST API Reference (V1)

Get A Website Delete A Website Create Website Abort Website Deletion Check If Website Exists

Website-Conversations

Delete Suggested Conversation Segment List Suggested Conversation Data Keys Submit Spam Conversation Decision Resolve Spam Conversation Content List Spam Conversations List Suggested Conversation Segments Delete Suggested Conversation Data Key ⭐ List Conversations

Website-Conversation

Initiate A Conversation With Existing Session Deliver Widget Button Action For Conversation Request Email Transcript For Conversation List Conversation Files Get Verify Status For Conversation ⭐ Get Conversation Metas ⭐ Change Conversation State Request Chatbox Binding Purge For Conversation Remove A Conversation ⭐ Send A Message In Conversation Save Conversation Participants Remove A Message In Conversation List Browsing Sessions For Conversation Update Conversation Open State Assist An Existing Browsing Session ⭐ Get Messages In Conversation Send Action To An Existing Browsing Session Compose A Message In Conversation Get Block Status For Conversation ⭐ Update Conversation Metas Get Conversation State ⭐ Mark Messages As Read In Conversation Request User Feedback For Conversation Check If Conversation Exists Update Verify Status For Conversation Get Conversation Participants ⭐ Mark Messages As Delivered In Conversation ⭐ Assign Conversation Routing Update Conversation Inbox Block Incoming Messages For Conversation List Conversation Events ⭐ Get A Conversation Deliver Widget Data Action For Conversation ⭐ Get Conversation Routing Assign Get A Message In Conversation Get An Original Message In Conversation ⭐ Create A New Conversation Get Ongoing Call Session For Conversation Initiate New Call Session For Conversation Abort Ongoing Call Session For Conversation Update A Message In Conversation Initiate Browsing Session For Conversation List Conversation Pages Transmit Signaling On Ongoing Call Session Schedule A Reminder For Conversation

List People Conversations List Suggested People Events Import People Profiles ⭐ Check If People Profile Exists Add A People Event ⭐ Save People Profile Get People Data ⭐ Get People Profile List Suggested People Data Keys ⭐ List People Profiles ⭐ Update People Profile Delete Suggested People Segment List People Events Delete Suggested People Event Update People Subscription Status ⭐ Remove People Profile Export People Profiles List Suggested People Segments ⭐ Add New People Profile Delete Suggested People Data Key Get People Subscription Status Save People Data List People Campaigns Update People Data Get People Statistics

Website-Visitors

Pinpoint Visitors On A Map List Visitors Clear Blocked Visitors In Rule Count Visitors Count Blocked Visitors In Rule Count Blocked Visitors Get Session Identifier From Token

Website-Availability

List Website Operator Availabilities Get Website Availability Status

Website-Operators

List Last Active Website Operators Flush Last Active Website Operators Send Email To Website Operators List Website Operators

Website-Operator

Get A Website Operator Invite A Website Operator Unlink Operator From Website Change Operator Membership

Website-Helpdesk

Resolve Helpdesk Locale Article List Helpdesk Locales Resolve Helpdesk Locale Article Category Resolve Helpdesk Save Helpdesk Locale Section Check If Helpdesk Locale Exists Delete Helpdesk Redirection Add Helpdesk Locale Resolve Helpdesk Locale Unpublish Helpdesk Locale Article Update Helpdesk Locale Section List Helpdesk Locale Article Alternates Update Helpdesk Locale Article Category Check If Helpdesk Locale Article Alternate Exists List Helpdesk Locale Categories Resolve Helpdesk Locale Article Page Update Helpdesk Locale Category Resolve Helpdesk Domain Delete Helpdesk Locale Article Alternate Delete Helpdesk Locale Article Map Helpdesk Locale Feedback Ratings Delete Helpdesk Locale Section Delete Helpdesk Locale List Helpdesk Locale Sections Resolve Helpdesk Locale Section Add Helpdesk Locale Section Check If Helpdesk Exists Save Helpdesk Locale Category Save Helpdesk Settings List Helpdesk Locale Feedbacks Save Helpdesk Locale Article Add Helpdesk Redirection Request Helpdesk Domain Change Resolve Helpdesk Locale Article Alternate Publish Helpdesk Locale Article Save Helpdesk Locale Article Alternate Check If Helpdesk Redirection Exists Resolve Helpdesk Settings List Helpdesk Locale Articles Initialize Helpdesk Generate Helpdesk Domain Setup Flow Resolve Helpdesk Locale Category List Helpdesk Redirections Delete Helpdesk Locale Category Add Helpdesk Locale Category Check If Helpdesk Locale Section Exists Delete Helpdesk Add A New Helpdesk Locale Article Update Helpdesk Locale Article Check If Helpdesk Locale Article Exists Check If Helpdesk Locale Category Exists Resolve Helpdesk Redirection Import External Helpdesk To Locale Export Helpdesk Locale Articles

Website-Campaigns

Save A Campaign Template Check If Campaign Template Exists Get A Campaign Template Create A New Campaign Template Update A Campaign Template List Campaign Tags List Campaign Templates List Campaigns Remove A Campaign Template

Website-Campaign

Pause A Campaign List Campaign Statistics Remove A Campaign Create A New Campaign Test A Campaign Resume A Campaign Check If Campaign Exists Save A Campaign List Campaign Recipients Dispatch A Campaign Get A Campaign Update A Campaign

Website-Analytics

Generate Analytics

Batch Resolve Items Batch Read Items Batch Remove Items

Website-Settings

Get Website Settings Update Website Settings

Get Verify Settings Get Verify Key Update Verify Settings Roll Verify Key

Plugin-Subscription

Get Subscription Details Report Plugin Usage To Bill Update Subscription Settings Get Subscription Settings Subscribe Website To Plugin Dispatch Plugin Event List All Active Subscriptions Forward Plugin Payload To Channel Get Plugin Usage Bills List Subscriptions For A Website Unsubscribe Plugin From Website Save Subscription Settings

Plugin-Connect Account

⭐ Get Connect Account

Plugin-Connect Session

⭐ Check Connect Session Validity

Plugin-Connect Websites

List Connect Websites Since ⭐ List All Connect Websites

Plugin-Connect Endpoints

⭐ Get Connect Endpoints

Generate Bucket URL

Media-Animation

List Animation Medias

Home Crisp REST API Reference (V1)Website-ConversationGet Conversation State

Get Conversation State

GET https://api.crisp.chat/v1/website/:website_id/conversation/:session_id/state

HEADERS

Key	Datatype	Required	Description
`Content-Type`	string
`X-Crisp-Tier`	string

⭐ Update Conversation Metas

⭐ Mark Messages As Read In Conversation