Show Menu
Search…
Ctrl+K
ESC
Example searches: “chatroom_pivot_data”, “type_chatroom”, “thread_id”, “application/json”, “topic”
API Changelog
Download source
JSON OpenAPI specification
YAML OpenAPI specification
Toggle dark mode
Topics
Introduction
Authentication
Getting started
Domain header
Endpoints
Ambassadors
Get all ambassadors (widget)
GET
Get an ambassador (widget)
GET
Get all posts of an ambassador (widget)
GET
Get all ambassadors (manager)
GET
Create a new ambassador (manager)
POST
Get all ambassadors with pertinence search (manager)
GET
Get an ambassador (manager)
GET
Update an ambassador (manager)
PATCH
Manually approve an ambassador (manager)
PATCH
Manually decline an ambassador (manager)
PATCH
Delete an ambassador address geocode (manager)
DELETE
Attach an ambassador address geocode (manager)
PATCH
Delete an ambassador point of sale (manager)
DELETE
Attach an ambassador point of sale (manager)
POST
Get subscribed alerts for an ambassador (manager)
GET
Update subscribed alerts for an ambassador (manager)
PATCH
Synchronize ambassador roles (manager)
PATCH
Alerts
Get all alerts (manager)
GET
Authentication
Login with email and password (public)
POST
Get a token from api key (public)
POST
Create a guest user to use the API
POST
Connect with brand user data
POST
Logout (public)
POST
Forgot Password (public)
POST
Reset Password (public)
POST
Register (public)
POST
BI
Get ambassador activity
GET
Get real time members KPI's
GET
Get real time orders KPI's
GET
Get real time conversations KPI's
GET
Get real time waiting list KPI's
GET
Brand
Get information about the Brand (public)
GET
Brand Config
Get the brand widget configuration (widget)
GET
Get the brand platform configuration (platform)
GET
Get the brand platform configuration (manager)
GET
Update the brand platform configuration (manager)
PATCH
Brand Tags
Get all brand tags
GET
Create a brand tag
POST
Get a brand tag by id
GET
Delete a brand tag by id
DELETE
Update a brand tag by id
PATCH
Attach an ambassador to a brand tag
POST
Detach an ambassador from a brand tag
DELETE
Chat
Create a chatroom
POST
Get a chatroom by id
GET
Update a chatroom by id
PATCH
Create and attach a thread to a chatroom
POST
Delete a thread from a chatroom
DELETE
Update a thread from a chatroom
PATCH
Check if a chatroom is an established dialogue
GET
Mark last message read by ambassador
POST
Get a message by id
GET
Update a message by id
PATCH
Plan a notification for a message
POST
Archive a chatroom
PATCH
Flag a chatroom
PATCH
Comment a chatroom
PATCH
Block a chatroom for an ambassador
PATCH
Get all ambassadors
GET
Create or retrieve a shop customer
POST
Update an ambassador
PATCH
Get all chatrooms of an ambassador
GET
Get all messages of a chatroom
GET
Post a message in a chatroom
POST
Rate a chatroom
POST
Get a rating by id
GET
Update a rating
PATCH
Post a message with product in a chatroom
POST
Get all brand tags
GET
Get the waiting list
GET
Add a user to the waiting list
POST
Get the waiting list
GET
Delete the waiting list
DELETE
Update the waiting list
PATCH
Search in brand rag documents for similar documents
GET
Chatroom
Get all chatrooms (manager)
GET
Get a chatroom by id (manager)
GET
Get AI generated summaries of a chatroom (manager)
GET
Generate an AI summary of a chatroom and store it (manager)
POST
Chat Topic
Get all chat topics (platform)
GET
Get all chat topics (manager)
GET
Create a chat topic (manager)
POST
Get a chat topic by id (manager)
GET
Update a chat topic by id (manager)
PATCH
Copilot
Reword a message using Copilot
POST
Geolocation
Get geolocation predictions (public)
GET
Get geolocation details (public)
GET
Images
Upload an image to the storage server and return the url (manager)
POST
Me
Get my ambassador information
GET
Update my ambassador information
PATCH
List my permissions (manager)
GET
Orders
Get all Orders (manager)
GET
Get an order by id (manager)
GET
Points of sale
Get all point of sales
GET
Create a point of sale
POST
Get a point of sale
GET
Delete a point of sale
DELETE
Update a point of sale
PATCH
Delete a point of sale address geocode (manager)
DELETE
Attach a point of sale address geocode
PATCH
Posts
Get all Ambassador Posts
GET
Get a Post by id
GET
Create a post
POST
Delete a post by id (manager)
DELETE
Update an Ambassador Post
PATCH
Add a video to a post
POST
Predefined Messages
Get all predefined messages (manager)
GET
Create a predefined message (manager)
POST
Get a predefined message by id (manager)
GET
Delete a predefined message by id (manager)
DELETE
Update a predefined message by id (manager)
PATCH
Products
Get all products (manager)
GET
Create a new product (manager)
POST
Get a product (manager)
GET
Delete a product (manager)
DELETE
Update a product (manager)
PATCH
Quiz
Get all quiz
GET
Create a quiz
POST
Get a quiz
GET
Update a quiz
PATCH
Session Time
Store session time (platform)
POST
Video Encoder
Update a video
PATCH
Widget Analytics
Post analytics records
POST
Web Push
Trigger a web push notification when a new message is sent
POST
Trigger a web push notification when a new visitor discussion is created
POST
Quiz Answers
Create an answer for a quiz
POST
Get a quiz answer
GET
Delete a quiz answer by id (manager)
DELETE
Dismiss highlight
Show more
Quiz Answers