Skip to content
RosettaChat Docs
Search
Ctrl
K
Cancel
RosettaChat
Select theme
Dark
Light
Auto
Overview
Web Chat Widget
Widget quickstart
Configuration & appearance
Signed visitor identity
Programmatic control (JS API)
Webhooks
Webhooks overview
Outbound webhooks
Inbound webhooks
API Reference
Overview
App Authentication
Overview
Register
Login
Request OTP
Verify OTP
Forgot Password
Reset Password
Logout
Change Password
App Authentication - Social
Overview
Get OAuth Redirect URL
OAuth Callback
List Linked Accounts
Link Social Account
Complete Link Social Account
Unlink Social Account
Devices
Register a push device.
Unregister a push device.
Email Verification
Overview
Verify Email
Resend Verification Email
Endpoints
Update my profile.
List my API tokens.
Create an API token.
Revoke an API token.
Show my personal plan.
Show my personal usage.
Start a billing checkout session.
Open the billing portal.
Sync my billing state.
Redeem a billing coupon.
Public preview of an invite so the join screen can show what the user is about to join — even before they sign in.
Redeem an invite: add the authenticated user to the workspace.
List my workspaces.
Create a workspace.
Show a workspace.
List my direct conversations.
Start a direct conversation.
Resolve a direct message recipient.
List messages in a direct conversation.
Send a direct message.
Mark a direct conversation read up to its latest message for the current participant.
Download a channel message attachment.
Download a direct message attachment.
List a workspace's channels.
Create a channel.
Update a channel.
Delete a channel.
List a workspace's members.
Update a workspace member's role.
Remove a workspace member.
List a workspace's invites.
Create a workspace invite.
Revoke a workspace invite.
List a webhook's recent requests.
List a workspace's inbound webhooks.
Create an inbound webhook.
Update an inbound webhook.
Delete an inbound webhook.
Current monthly usage and plan limits for a workspace (members only).
List the explicit members of a private channel.
Add an existing workspace member to a private channel.
Remove a member from a private channel.
Cursor-paginated channel history. Returns the newest `limit` messages by default, oldest-first for display. Pass `before=<messageId>` to fetch the window immediately older than that cursor (ULID ordering, ties-free).
Send a channel message.
Full thread payload for a root message: the root plus all of its replies, oldest-first. Independent of the channel pagination window so threads load reliably even for old roots scrolled out of the main history.
Mark a channel read up to its latest message for the current member.
Send a channel message with an API token.
Post a message into a channel via webhook.
External Temporary Rooms
Join a Temporary Room as a guest
List guest-visible room messages
Send a guest room message
Files
Upload a file.
Show file metadata.
Delete a file (soft delete + remove from disk).
Stream the file contents to the client.
Me
List my files.
List my push devices.
Outbound Webhooks
Overview
List outbound webhooks.
Create an outbound webhook.
Delete an outbound webhook.
Update an outbound webhook.
Send a test outbound webhook.
List an outbound webhook's deliveries.
Retry an outbound webhook delivery.
Shared Authentication
Overview
Get Current User
Support Analytics
Overview
Show support analytics.
Support Automation
List a workspace's support conversations, filterable by the embedder's own identifiers. Sandbox (`is_test`) conversations are excluded unless `include_test=1`.
Show a single support conversation within the workspace.
List a conversation's transcript (oldest first).
Support Inbox
Overview
List the support conversations the authenticated agent can handle.
Show a single conversation.
List a support conversation's messages.
Reply to a support conversation.
List the workspace's support agents for the assignment picker.
Assign a support conversation.
Unassign a support conversation.
Snooze a support conversation.
Close a support conversation.
Reopen a support conversation.
List a conversation's internal notes.
Add an internal note.
Delete an internal note.
Update an internal note.
Tag a support conversation.
Remove a tag from a support conversation.
List a workspace's support tags.
Create a support tag.
Delete a support tag.
Update a support tag.
List canned responses.
Create a canned response.
Delete a canned response.
Update a canned response.
Support Widget Admin
Overview
Show the chat widget configuration.
Create the chat widget configuration.
Update the chat widget configuration.
Generate (or rotate) the per-site identity-signing secret used to verify signed visitor identities. Returned exactly once — like the public key, the raw value never appears in the normal show/update responses.
Show the support bot configuration.
Update the support bot configuration.
List Marknest folders for the support bot.
List Marknest tags for the support bot.
Test the support bot's Marknest connection.
List support webhooks.
Create a support webhook.
Delete a support webhook.
Update a support webhook.
Send a test support webhook.
Temporary Rooms
List owned Temporary Rooms
Create a Temporary Room
Show a Temporary Room
Close a Temporary Room
Update a Temporary Room
Show Temporary Room usage summary
Extend a Temporary Room
Web Authentication
Overview
Register
Login
Request OTP
Verify OTP
Forgot Password
Reset Password
Logout
Change Password
Web Authentication - Social
Overview
Get OAuth Redirect URL
Browser OAuth Callback
OAuth Callback
List Linked Accounts
Link Social Account
Complete Link Social Account
Unlink Social Account
Sandbox & Testing
Sandbox & testing
RosettaChat
Select theme
Dark
Light
Auto
Sync my billing state.
POST
/api/v1/me/billing/sync
Responses
Section titled “ Responses ”