# Thomsell API ## Description This is version `0.1` of this API documentation. Last update on Oct 1, 2025. Welcome to Thomsell API Documentation! ## Servers - https://domain.tld/api/v2: https://domain.tld/api/v2 () ## Authentication ## Topics - [Getting started](https://apidoc.thomsell.com/topic/topic-getting-started.md) - [Domain header](https://apidoc.thomsell.com/topic/topic-domain-header.md) ## Endpoints and operations ### [Ambassadors](https://apidoc.thomsell.com/group/endpoint-ambassadors.md) - [Get all ambassadors (widget)](https://apidoc.thomsell.com/operation/operation-get-widget-ambassadors.md) - [Get an ambassador (widget)](https://apidoc.thomsell.com/operation/operation-get-widget-ambassadors-parameter.md) - [Get all posts of an ambassador (widget)](https://apidoc.thomsell.com/operation/operation-get-widget-ambassadors-parameter-posts.md) - [Get all ambassadors (manager)](https://apidoc.thomsell.com/operation/operation-get-manager-ambassadors.md) - [Create a new ambassador (manager)](https://apidoc.thomsell.com/operation/operation-post-manager-ambassadors.md) - [Get all ambassadors with pertinence search (manager)](https://apidoc.thomsell.com/operation/operation-get-manager-ambassadors-micro-resource.md) - [Get an ambassador (manager)](https://apidoc.thomsell.com/operation/operation-get-manager-ambassadors-parameter.md) - [Update an ambassador (manager)](https://apidoc.thomsell.com/operation/operation-patch-manager-ambassadors-parameter.md) - [Manually approve an ambassador (manager)](https://apidoc.thomsell.com/operation/operation-patch-manager-ambassadors-parameter-approve.md) - [Manually decline an ambassador (manager)](https://apidoc.thomsell.com/operation/operation-patch-manager-ambassadors-parameter-decline.md) - [Delete an ambassador address geocode (manager)](https://apidoc.thomsell.com/operation/operation-delete-manager-ambassadors-parameter-address-geocode.md) - [Attach an ambassador address geocode (manager)](https://apidoc.thomsell.com/operation/operation-patch-manager-ambassadors-parameter-address-geocode.md) - [Delete an ambassador point of sale (manager)](https://apidoc.thomsell.com/operation/operation-delete-manager-ambassadors-parameter-point-of-sale.md) - [Attach an ambassador point of sale (manager)](https://apidoc.thomsell.com/operation/operation-post-manager-ambassadors-parameter-point-of-sale-parameter.md) - [Get all ambassadors (Platform)](https://apidoc.thomsell.com/operation/operation-get-platform-ambassadors.md) - [Get an ambassador (platform)](https://apidoc.thomsell.com/operation/operation-get-platform-ambassadors-parameter.md) - [Get all active challenges and number of win by the request ambassador (Platform)](https://apidoc.thomsell.com/operation/operation-get-platform-ambassadors-parameter-challenges.md) - [Get ambassador stats (Platform)](https://apidoc.thomsell.com/operation/operation-get-platform-ambassadors-parameter-stats.md) - [Get ambassador orders (Platform)](https://apidoc.thomsell.com/operation/operation-get-platform-ambassadors-parameter-orders.md) - [Get unread notifications for an ambassador (platform)](https://apidoc.thomsell.com/operation/operation-get-platform-ambassadors-parameter-notifications.md) - [synchronize ambassador roles (manager)](https://apidoc.thomsell.com/operation/operation-patch-manager-ambassadors-parameter-roles.md) - [Anonymize an ambassador (manager)](https://apidoc.thomsell.com/operation/operation-patch-manager-ambassadors-parameter-anonymize.md) ### [Authentication](https://apidoc.thomsell.com/group/endpoint-authentication.md) - [Login with email and password (public)](https://apidoc.thomsell.com/operation/operation-post-auth-login.md) - [get a token from api key (public)](https://apidoc.thomsell.com/operation/operation-post-auth-token.md) - [Create a guest user to use the API](https://apidoc.thomsell.com/operation/operation-post-auth-guest.md) - [Connect with brand user data](https://apidoc.thomsell.com/operation/operation-post-auth-brand.md) - [Logout (public)](https://apidoc.thomsell.com/operation/operation-post-auth-logout.md) - [Forgot Password (public)](https://apidoc.thomsell.com/operation/operation-post-auth-forgot-password.md) - [Reset Password (public)](https://apidoc.thomsell.com/operation/operation-post-auth-reset-password.md) - [Register (public)](https://apidoc.thomsell.com/operation/operation-post-auth-register.md) ### [BI](https://apidoc.thomsell.com/group/endpoint-bi.md) - [Get ambassador activity](https://apidoc.thomsell.com/operation/operation-get-manager-bi-realtime-activity.md) - [Get real time members KPI's](https://apidoc.thomsell.com/operation/operation-get-manager-bi-realtime-members.md) - [Get real time orders KPI's](https://apidoc.thomsell.com/operation/operation-get-manager-bi-realtime-orders.md) - [Get real time conversations KPI's](https://apidoc.thomsell.com/operation/operation-get-manager-bi-realtime-chatrooms.md) - [Get real time waiting list KPI's](https://apidoc.thomsell.com/operation/operation-get-manager-bi-realtime-requests.md) ### [Brand](https://apidoc.thomsell.com/group/endpoint-brand.md) - [Get information about the Brand (public)](https://apidoc.thomsell.com/operation/operation-get-brand.md) ### [Brand Config](https://apidoc.thomsell.com/group/endpoint-brand-config.md) - [Get the brand widget configuration (widget)](https://apidoc.thomsell.com/operation/operation-get-widget-config.md) - [Get the brand platform configuration (platform)](https://apidoc.thomsell.com/operation/operation-get-platform-config.md) ### [Brand Tags](https://apidoc.thomsell.com/group/endpoint-brand-tags.md) - [Get all brand tags](https://apidoc.thomsell.com/operation/operation-get-manager-brand-tags.md) - [Create a brand tag](https://apidoc.thomsell.com/operation/operation-post-manager-brand-tags.md) - [Get a brand tag by id](https://apidoc.thomsell.com/operation/operation-get-manager-brand-tags-parameter.md) - [Delete a brand tag by id](https://apidoc.thomsell.com/operation/operation-delete-manager-brand-tags-parameter.md) - [Update a brand tag by id](https://apidoc.thomsell.com/operation/operation-patch-manager-brand-tags-parameter.md) - [Attach an ambassador to a brand tag](https://apidoc.thomsell.com/operation/operation-post-manager-brand-tags-parameter-ambassador-parameter.md) - [Detach an ambassador from a brand tag](https://apidoc.thomsell.com/operation/operation-delete-manager-brand-tags-parameter-ambassador-parameter.md) ### [Chat](https://apidoc.thomsell.com/group/endpoint-chat.md) - [Create a chatroom](https://apidoc.thomsell.com/operation/operation-post-chat-chatrooms.md) - [Get a chatroom by id](https://apidoc.thomsell.com/operation/operation-get-chat-chatrooms-parameter.md) - [update a chatroom by id](https://apidoc.thomsell.com/operation/operation-patch-chat-chatrooms-parameter.md) - [Create and attach a thread to a chatroom](https://apidoc.thomsell.com/operation/operation-post-chat-chatrooms-parameter-thread.md) - [Delete a thread from a chatroom](https://apidoc.thomsell.com/operation/operation-delete-chat-chatrooms-parameter-thread.md) - [Update a thread from a chatroom](https://apidoc.thomsell.com/operation/operation-patch-chat-chatrooms-parameter-thread.md) - [Check if a chatroom is an established dialogue](https://apidoc.thomsell.com/operation/operation-get-chat-chatrooms-parameter-check-dialogue.md) - [Mark last message read by ambassador](https://apidoc.thomsell.com/operation/operation-post-chat-chatrooms-parameter-ambassadors-parameter-read.md) - [Get a message by id](https://apidoc.thomsell.com/operation/operation-get-chat-messages-parameter.md) - [update a message by id](https://apidoc.thomsell.com/operation/operation-patch-chat-messages-parameter.md) - [Plan a notification for a message](https://apidoc.thomsell.com/operation/operation-post-chat-messages-parameter-plan-notification.md) - [Archive a chatroom](https://apidoc.thomsell.com/operation/operation-patch-chat-chatrooms-parameter-ambassadors-parameter-archive.md) - [Flag a chatroom](https://apidoc.thomsell.com/operation/operation-patch-chat-chatrooms-parameter-ambassadors-parameter-flag.md) - [comment a chatroom](https://apidoc.thomsell.com/operation/operation-patch-chat-chatrooms-parameter-ambassadors-parameter-comment.md) - [Block a chatroom for an ambassador](https://apidoc.thomsell.com/operation/operation-patch-chat-chatrooms-parameter-ambassadors-parameter-block.md) - [Get all ambassadors](https://apidoc.thomsell.com/operation/operation-get-chat-ambassadors.md) - [Create or retrieve a shop customer](https://apidoc.thomsell.com/operation/operation-post-chat-ambassadors-shop-customer.md) - [Update an ambassador](https://apidoc.thomsell.com/operation/operation-patch-chat-ambassadors-parameter.md) - [Get all chatrooms of an ambassador](https://apidoc.thomsell.com/operation/operation-get-chat-ambassadors-parameter-chatrooms.md) - [Get all messages of a chatroom](https://apidoc.thomsell.com/operation/operation-get-chat-chatrooms-parameter-messages.md) - [Post a message in a chatroom](https://apidoc.thomsell.com/operation/operation-post-chat-chatrooms-parameter-messages.md) - [Rate a chatroom](https://apidoc.thomsell.com/operation/operation-post-chat-chatrooms-parameter-ratings.md) - [Get a rating by id](https://apidoc.thomsell.com/operation/operation-get-chat-ratings-parameter.md) - [Update a rating](https://apidoc.thomsell.com/operation/operation-patch-chat-ratings-parameter.md) - [Post a message with product in a chatroom](https://apidoc.thomsell.com/operation/operation-post-chat-chatrooms-parameter-messages-product.md) - [Get all brand tags](https://apidoc.thomsell.com/operation/operation-get-chat-brand-tags.md) - [Get the waiting list](https://apidoc.thomsell.com/operation/operation-get-chat-waiting-list.md) - [Add a user to the waiting list](https://apidoc.thomsell.com/operation/operation-post-chat-waiting-list.md) - [Get the waiting list](https://apidoc.thomsell.com/operation/operation-get-chat-waiting-list-parameter.md) - [Delete the waiting list](https://apidoc.thomsell.com/operation/operation-delete-chat-waiting-list-parameter.md) - [Update the waiting list](https://apidoc.thomsell.com/operation/operation-patch-chat-waiting-list-parameter.md) - [Search in brand rag documents for similar documents](https://apidoc.thomsell.com/operation/operation-get-chat-rag-search-documents.md) - [Purge a chatroom (delete all messages)](https://apidoc.thomsell.com/operation/operation-patch-chat-chatrooms-parameter-purge.md) ### [Chatroom](https://apidoc.thomsell.com/group/endpoint-chatroom.md) - [Get all chatrooms (manager)](https://apidoc.thomsell.com/operation/operation-get-manager-chatrooms.md) - [Get a chatroom by id (manager)](https://apidoc.thomsell.com/operation/operation-get-manager-chatrooms-parameter.md) - [Get AI generated summaries of a chatroom (manager)](https://apidoc.thomsell.com/operation/operation-get-manager-chatrooms-parameter-summaries.md) - [Generate an AI summary of a chatroom and store it (manager)](https://apidoc.thomsell.com/operation/operation-post-manager-chatrooms-parameter-summaries.md) - [Create a message audio (platform / widget)](https://apidoc.thomsell.com/operation/operation-post-parameter-chatrooms-parameter-message-audio.md) - [Create a message pdf (platform)](https://apidoc.thomsell.com/operation/operation-post-platform-chatrooms-parameter-message-pdf.md) ### [Chat Topic](https://apidoc.thomsell.com/group/endpoint-chat-topic.md) - [Get all chat topics (platform)](https://apidoc.thomsell.com/operation/operation-get-platform-chat-topics.md) - [Get all chat topics (manager)](https://apidoc.thomsell.com/operation/operation-get-manager-chat-topics.md) - [Create a chat topic (manager)](https://apidoc.thomsell.com/operation/operation-post-manager-chat-topics.md) - [Get a chat topic by id (manager)](https://apidoc.thomsell.com/operation/operation-get-manager-chat-topics-parameter.md) - [Update a chat topic by id (manager)](https://apidoc.thomsell.com/operation/operation-patch-manager-chat-topics-parameter.md) ### [Copilot](https://apidoc.thomsell.com/group/endpoint-copilot.md) - [Reword a message using Copilot](https://apidoc.thomsell.com/operation/operation-post-chat-copilot-reword-message.md) ### [Features](https://apidoc.thomsell.com/group/endpoint-features.md) - [get feature flags](https://apidoc.thomsell.com/operation/operation-get-parameter-features.md) ### [Geolocation](https://apidoc.thomsell.com/group/endpoint-geolocation.md) - [Get geolocation predictions (public)](https://apidoc.thomsell.com/operation/operation-get-geolocation-autocomplete.md) - [Get geolocation details (public)](https://apidoc.thomsell.com/operation/operation-get-geolocation-details.md) ### [Images](https://apidoc.thomsell.com/group/endpoint-images.md) - [Upload an image to the storage server and return the url (manager)](https://apidoc.thomsell.com/operation/operation-post-parameter-images.md) ### [Me](https://apidoc.thomsell.com/group/endpoint-me.md) - [Get my ambassador information](https://apidoc.thomsell.com/operation/operation-get-parameter-me.md) - [Update my ambassador information](https://apidoc.thomsell.com/operation/operation-patch-parameter-me.md) - [Attach my ambassador address geocode](https://apidoc.thomsell.com/operation/operation-patch-platform-me-address-geocode.md) - [Attach my ambassador point of sale](https://apidoc.thomsell.com/operation/operation-patch-platform-me-point-of-sale-parameter.md) - [List my permissions (manager)](https://apidoc.thomsell.com/operation/operation-get-manager-me-permissions.md) ### [Notifications](https://apidoc.thomsell.com/group/endpoint-notifications.md) - [Mark a notification as read](https://apidoc.thomsell.com/operation/operation-patch-notifications-parameter-read.md) ### [Orders](https://apidoc.thomsell.com/group/endpoint-orders.md) - [Get all Orders (manager)](https://apidoc.thomsell.com/operation/operation-get-manager-orders.md) - [Get an order by id (manager)](https://apidoc.thomsell.com/operation/operation-get-manager-orders-parameter.md) - [Create an order (widget)](https://apidoc.thomsell.com/operation/operation-post-widget-orders.md) ### [Points of sale](https://apidoc.thomsell.com/group/endpoint-points-of-sale.md) - [Get all point of sales](https://apidoc.thomsell.com/operation/operation-get-manager-points-of-sale.md) - [Create a point of sale](https://apidoc.thomsell.com/operation/operation-post-manager-points-of-sale.md) - [Get a point of sale](https://apidoc.thomsell.com/operation/operation-get-manager-points-of-sale-parameter.md) - [Delete a point of sale](https://apidoc.thomsell.com/operation/operation-delete-manager-points-of-sale-parameter.md) - [Update a point of sale](https://apidoc.thomsell.com/operation/operation-patch-manager-points-of-sale-parameter.md) - [Delete a point of sale address geocode (manager)](https://apidoc.thomsell.com/operation/operation-delete-manager-points-of-sale-parameter-address-geocode.md) - [Attach a point of sale address geocode](https://apidoc.thomsell.com/operation/operation-patch-manager-points-of-sale-parameter-address-geocode.md) ### [Popliste](https://apidoc.thomsell.com/group/endpoint-popliste.md) - [Create a popliste (manager)](https://apidoc.thomsell.com/operation/operation-post-manager-popliste.md) - [Update a popliste (manager)](https://apidoc.thomsell.com/operation/operation-patch-manager-popliste-parameter.md) - [Create a popliste (platform)](https://apidoc.thomsell.com/operation/operation-post-platform-popliste.md) - [Create an image product for a popliste (platform)](https://apidoc.thomsell.com/operation/operation-post-platform-popliste-parameter-image.md) ### [Posts](https://apidoc.thomsell.com/group/endpoint-posts.md) - [Get all Ambassador Posts](https://apidoc.thomsell.com/operation/operation-get-parameter-posts.md) - [Get a Post by id](https://apidoc.thomsell.com/operation/operation-get-parameter-posts-parameter.md) - [Create a post](https://apidoc.thomsell.com/operation/operation-post-manager-posts.md) - [Delete a post by id (manager)](https://apidoc.thomsell.com/operation/operation-delete-manager-posts-parameter.md) - [Update an Ambassador Post](https://apidoc.thomsell.com/operation/operation-patch-manager-posts-parameter.md) - [Add a video to a post](https://apidoc.thomsell.com/operation/operation-post-platform-posts-parameter-video.md) - [Get all likes of a post](https://apidoc.thomsell.com/operation/operation-get-platform-posts-parameter-likes.md) - [Like a post](https://apidoc.thomsell.com/operation/operation-post-platform-posts-parameter-like.md) - [Unlike a post](https://apidoc.thomsell.com/operation/operation-delete-platform-posts-parameter-like.md) - [Get all comments of a post](https://apidoc.thomsell.com/operation/operation-get-platform-posts-parameter-comments.md) - [Add a comment to a post](https://apidoc.thomsell.com/operation/operation-post-platform-posts-parameter-comments.md) - [Delete a comment](https://apidoc.thomsell.com/operation/operation-delete-platform-comments-parameter.md) - [Update a comment](https://apidoc.thomsell.com/operation/operation-patch-platform-comments-parameter.md) ### [Predefined Messages](https://apidoc.thomsell.com/group/endpoint-predefined-messages.md) - [Get all predefined messages (manager)](https://apidoc.thomsell.com/operation/operation-get-manager-predefined-messages.md) - [Create a predefined message (manager)](https://apidoc.thomsell.com/operation/operation-post-manager-predefined-messages.md) - [Get a predefined message by id (manager)](https://apidoc.thomsell.com/operation/operation-get-manager-predefined-messages-parameter.md) - [Delete a predefined message by id (manager)](https://apidoc.thomsell.com/operation/operation-delete-manager-predefined-messages-parameter.md) - [Update a predefined message by id (manager)](https://apidoc.thomsell.com/operation/operation-patch-manager-predefined-messages-parameter.md) ### [Products](https://apidoc.thomsell.com/group/endpoint-products.md) - [Get all products (manager)](https://apidoc.thomsell.com/operation/operation-get-manager-products.md) - [Create a new product (manager)](https://apidoc.thomsell.com/operation/operation-post-manager-products.md) - [Get a product (manager)](https://apidoc.thomsell.com/operation/operation-get-manager-products-parameter.md) - [Delete a product (manager)](https://apidoc.thomsell.com/operation/operation-delete-manager-products-parameter.md) - [Update a product (manager)](https://apidoc.thomsell.com/operation/operation-patch-manager-products-parameter.md) - [Pick a product (platform)](https://apidoc.thomsell.com/operation/operation-post-platform-products-pick-product.md) ### [Push Notification](https://apidoc.thomsell.com/group/endpoint-push-notification.md) - [Store a new ambassador push notification](https://apidoc.thomsell.com/operation/operation-post-platform-push-notification.md) ### [Quiz](https://apidoc.thomsell.com/group/endpoint-quiz.md) - [Get all quiz](https://apidoc.thomsell.com/operation/operation-get-manager-quiz.md) - [Create a quiz](https://apidoc.thomsell.com/operation/operation-post-manager-quiz.md) - [Get a quiz](https://apidoc.thomsell.com/operation/operation-get-manager-quiz-parameter.md) - [Update a quiz](https://apidoc.thomsell.com/operation/operation-patch-manager-quiz-parameter.md) - [Participate to a quiz](https://apidoc.thomsell.com/operation/operation-post-platform-quiz-parameter-participate.md) ### [Session Time](https://apidoc.thomsell.com/group/endpoint-session-time.md) - [store session time (platform)](https://apidoc.thomsell.com/operation/operation-post-parameter-session-times.md) ### [Video Encoder](https://apidoc.thomsell.com/group/endpoint-video-encoder.md) - [Update a video](https://apidoc.thomsell.com/operation/operation-patch-video-encoder-videos-parameter.md) ### [Widget Analytics](https://apidoc.thomsell.com/group/endpoint-widget-analytics.md) - [post analytics records](https://apidoc.thomsell.com/operation/operation-post-widget-analytics.md) ### [Web Push](https://apidoc.thomsell.com/group/endpoint-web-push.md) - [Trigger a web push notification when a new message is sent](https://apidoc.thomsell.com/operation/operation-post-chat-web-push-new-chat-message-parameter-ambassador-parameter.md) - [Trigger a web push notification when a new visitor discussion is created](https://apidoc.thomsell.com/operation/operation-post-chat-web-push-new-visitor-discussion-parameter-ambassador-parameter.md) ### [Quiz Answers](https://apidoc.thomsell.com/group/endpoint-quiz-answers.md) - [Create an answer for a quiz](https://apidoc.thomsell.com/operation/operation-post-manager-quiz-answer.md) - [Get a quiz answer](https://apidoc.thomsell.com/operation/operation-get-manager-quiz-answer-parameter.md) - [Delete a quiz answer by id (manager)](https://apidoc.thomsell.com/operation/operation-delete-manager-quiz-answer-parameter.md) [Powered by Bump.sh](https://bump.sh)