Toggle dark mode

Download source

JSON OpenAPI specification
YAML OpenAPI specification

Topics

Introduction
Authentication
Getting started
Domain header

Endpoints

Ambassadors
Alerts
- Get all alerts (manager) GET
Authentication
BI
Brand
- Get information about the Brand (public) GET
Brand Config
Chat
Chatroom
Chat Topic
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
Orders
- Get all Orders (manager) GET
- Get an order by id (manager) GET
Points of sale
Posts
Predefined Messages
Products
Quiz
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

Powered by Bump.sh

Getting started

Before using the API you need to authenticate yourself and get a token . see the Authentication endpoints