Use to navigate results, ENTER to select one, ESC to close

Type in any word to easily find the endpoint, property or group of operations you are looking for.

API changelog

Download source

JSON OpenAPI specification
YAML OpenAPI specification

Toggle dark mode

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
- Get the brand widget configuration (widget) GET
- Get the brand platform configuration (platform) GET
Brand Tags
Chat
Chatroom
Chat Topic
Challenge
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 POST
Me
Notifications
- Mark a notification as read PATCH
Orders
Points of sale
Popliste
Posts
Predefined Messages
Products
Push Notification
- Store a new ambassador push notification POST
- Store a new ambassador push notification POST
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
Wallet
Quiz Answers
Vectors

Powered by Bump.sh

API changelog

Download source

JSON OpenAPI specification
YAML OpenAPI specification

Toggle dark mode

Me

Ask AI

Open in ChatGPT
Open in Claude

View as Markdown
Copy as Markdown

Ambassadors API - Authenticated Account Settings