Deskwoot REST API

List conversations, newest activity first unless sort=oldest. Without type it lists customer conversations only, never tickets. Each row carries its category, and needsAttention: true while a team has it, nobody holds it, it is open or pending and the AI bot is not answering it. A conversation that waits in the round robin queue (queuedAt set) never needs attention, since the queue hands it to an agent on its own. While Jira is connected and tickets are on, a ticket with linked Jira issues also carries linkedIssues (the first 3: key, url, statusName, statusCategory, deleted, notFound) and linkedIssueCount. Paged by page and pageSize (meta.total counts every match), or by cursor: cursor=start, then meta.nextCursor while meta.hasMore.

Auth: Bearer token (conversations:read) or session

Retrieve a single conversation with its contact, inbox, assignee, team, labels, and messages.

Auth: Bearer token (conversations:read) or session

Update a conversation's status, priority, assignee, team, or custom attributes.

Auth: Bearer token (conversations:write) or session

Update multiple conversations at once. Supports status changes, assignments, priority, labels, and muting.

Auth: Bearer token (conversations:write) or session

List all messages in a conversation, including sender info and attachments. With the Virus scan add-on, an inbound file whose scan could not run yet is listed under pendingScanAttachments (name and type, no URL) and moves to attachments once the scan has passed it.

Auth: Bearer token (conversations:read) or session

Who did what to a conversation or ticket, newest first, under the read rules of the conversation itself. activity holds its activity lines (the team only ones too) with meta { hasMore, nextCursor, limit }. assignments holds one row per stretch of time an agent held it: assignee, assignedAt, unassignedAt (null while it lasts), startInferred, how it started (source, assignedBy) and how it ended (endSource, unassignedBy). Later releases can add source values, so treat an unknown one as a plain change. A line or stretch a merge moved in carries mergedFrom { conversationId, displayId } (displayId null when not known).

Auth: Bearer token (conversations:read) or session

Send a new message in a conversation. The message is delivered to the customer through the original channel.

Auth: Bearer token (conversations:write) or session

Send a message with one or more files (multipart/form-data). All files go on one message, in the order you send them. Up to 10 files per message, 10 MB per file and 20 MB in total.

Auth: Bearer token (conversations:write) or session

Add a label to a conversation.

Auth: Bearer token (conversations:write) or session

Remove a label from a conversation.

Auth: Bearer token (conversations:write) or session

Store an incoming customer message. The contact is found or created by externalContactId (stored as the contact's identifier), and the message joins that contact's open conversation in the inbox or opens a new one. contactName names the contact (a new one, and an existing one whose name differs); contactEmail and contactPhone fill a contact the message creates (an email another contact has is left out). subject, priority, assigneeId and customAttributes set up a conversation the message opens (isNewConversation true); a message that joins a conversation still open leaves that conversation as it is. Answers 200 { ok, conversationId, messageId, isNewConversation }. A retry with the same sourceId, Idempotency-Key header or messageId stores nothing and answers { ok: true, deduped: true }. At most 120 requests a minute per token; 404 when inboxId is no API inbox of the workspace.

Auth: Bearer token (inbound:ingest, which the broad write scope does not cover)

Whether free text reaches the customer now, until when, and on a WhatsApp Cloud API inbox the approved templates you can send instead, to a person or a WhatsApp group (templates.available is always true).

Auth: Bearer token (conversations:read) or session

Every template of a WhatsApp Cloud API inbox as last synced, with its status. Add sendable=1 for the ones a send may use (approved, and of a kind Deskwoot sends: not authentication, carousel, flow, catalog or location templates), and contactId to learn whether that contact's window on this inbox is open.

Auth: Bearer token (inboxes:read) or session

Send an approved template into a conversation: pass template instead of content. The template is checked against the inbox's approved templates, each value may use the canned response variables such as {{contact.first_name}}, and the stored message holds the text the customer reads, with contentAttributes.template naming the template and its values.

Auth: Bearer token (conversations:write) or session

Create a ticket from messages of a conversation and hand it to a team and/or an agent. The agent gets it at once, without a capacity check; a team without an agent leaves it unassigned in the team's folder, and the team's members are notified. The conversation gets a team only status card that follows the ticket. Nothing reaches the customer. An Idempotency-Key header names the request; without one the request itself does, so the same request twice within 2 minutes answers with the first ticket (200 instead of 201).

Auth: Bearer token (conversations:write) or session (conversations.manage)

The tickets made from a conversation, newest first (up to 100): id, displayId, title, status, priority, createdAt, lastActivityAt, assignee, team, category, createdBy, and canOpen (whether the caller may open the ticket itself).

Auth: Bearer token (conversations:read) or session

What a new ticket of this conversation can be made from. defaultSelection lists the ids picked by default, oldest first: the messages since the conversation was last resolved or last made into a ticket, at least the customer's last messages; since is the moment that boundary stands at (null for the conversation's start). data and meta are one page of the messages that can be context, newest page first. 409 ticket_source for a ticket.

Auth: Bearer token (conversations:read) or session

The conversation a ticket came from, read through the ticket: whoever may read the ticket reads these, also without access to the conversation itself. source is the conversation (null once it was deleted). context holds the messages the ticket was made from, in their order, with contextMeta { hasMore, nextCursor }. newer holds the conversation's messages after the context, newest page first; it is empty, with code source_locked and the plan's reason, while the plan locks or hides the conversation. 409 not_ticket for a conversation.

Auth: Bearer token (conversations:read) or session

Reply to the customer from a ticket. The reply is stored in the conversation the ticket came from and delivered there on its channel (an email in the original thread), with the limits, virus scan and Idempotency-Key replay of a normal reply. The ticket gets a team only line pointing to it. The conversation is not claimed, gets no join line and stays resolved if it was. With files, send the attachments endpoint's multipart form plus resolve=true and ticketStatusId.

Auth: Bearer token (conversations:write) or session (conversations.manage)

Resolve a conversation and file its current interaction as a resolved ticket (Keep as a resolved ticket in the Resolve chat dialog). The interaction is what ticket-context selects by default. The caller creates and holds the ticket, it gets the conversation's team, the category asked for or else the conversation's own, the conversation's priority or else the workspace's default priority for new tickets, and a title from the interaction. It begins at the interaction's first customer message, so its resolution time is the interaction's. Nobody is notified. The ticket is filed first: a refusal leaves the conversation as it was. When nothing was written since the last resolve or ticket, ticket is null and the conversation is still resolved. An Idempotency-Key makes a retry answer with the same ticket.

Auth: Bearer token (conversations:write) or session (conversations.manage)

Draft with Copilot: a title and a summary for a ticket made from these messages of the conversation, and from nothing else. Nothing is written and nothing reaches the customer. Needs the Copilot (its plan, quota and rate limits) and the conversations.notes_summarize permission; billed like a Copilot answer. Answers { title, summary, usedCount, omittedCount }.

Auth: Session only

The workspace's categories in their order, archived ones included: id, name, position, archived, archivedAt.

Auth: Bearer token (conversations:read) or session

Add a category at the end of the order. 409 name_taken when the name exists already.

Auth: Session (permission: settings.manage_ticket_categories), Enterprise plan

Rename, move or archive a category.

Auth: Session (permission: settings.manage_ticket_categories), Enterprise plan

Delete a category. 409 category_in_use while a conversation or ticket has it; archive it instead.

Auth: Session (permission: settings.manage_ticket_categories), Enterprise plan

The workspace's ticket statuses in their order, archived ones included: id, name, baseStatus, pausesSla, position, archived, archivedAt.

Auth: Bearer token (conversations:read) or session

Add a status at the end of the order, at most 50 per workspace. 409 name_taken when the name exists already.

Auth: Session (permission: settings.manage_ticket_categories), Enterprise plan

Rename, move or archive a status, or switch its SLA pause (from that moment on).

Auth: Session (permission: settings.manage_ticket_categories), Enterprise plan

Delete a status. 409 ticket_status_in_use while a ticket has it; archive it instead.

Auth: Session (permission: settings.manage_ticket_categories), Enterprise plan

Create a tracker, open, with its summary as the first internal note. An Idempotency-Key header makes a repeat answer with the first tracker (replayed: true) instead of a second one.

Auth: Bearer token (conversations:write) or session (conversations.manage)

What is linked to a tracker, newest link first: id, displayId, kind, title, status, priority, sourceConversationId, contact (with its organization), channelType, assignee, team, linkedAt, linkedBy, and lastUpdate, what the tracker's latest update did for it (null when it did not name it). meta { hasMore, nextCursor, limit, hiddenCount, shownCount }: hiddenCount counts the linked items you may not open, which are left out. On a conversation or a customer's ticket it answers { trackers } instead: the trackers it is linked to that you may open (at most 100).

Auth: Bearer token (conversations:read) or session

Link conversations and customers' tickets to a tracker, with a line on both. Answers { results }, one per id in the order asked: { conversationId, outcome } with outcome linked, already_linked or refused (with code not_found, tracker or source_spam, and error). A row you may not open is not_found. The tracker sends ticket.updated with changes.links.

Auth: Bearer token (conversations:write) or session (conversations.manage)

Unlink one conversation or ticket from a tracker, with a line on both. A conversation whose survey waited for the tracker gets it now, unless something else holds it. Answers { unlinked: true }; 409 not_tracker, not_linked.

Auth: Bearer token (conversations:write) or session (conversations.manage)

Update the customers of everything linked to a tracker, and resolve the linked items and the tracker, as asked. Text only. Each conversation gets the update once (a conversation and its tickets count as one, at most 500), as a reply in that conversation with its reply window and refusals. dryRun answers what would happen and writes nothing. Every other request needs an Idempotency-Key header: a retry sends nothing again and answers replayed for what the first one sent. A person sends at most 10 updates a minute.

Auth: Session (conversations.manage) or a REST API token (conversations:write); MCP tokens are refused

A ticket's linked issues, the first linked first: { data: [{ id, provider, siteId, externalId, key, url, title, statusName, statusCategory, deleted, notFound, syncedAt, raised, linkedAt, linkedBy }], jira }. statusCategory is TODO, IN_PROGRESS or DONE; syncedAt is when Jira last reported that state; deleted is true once the issue was deleted in Jira, notFound when the hourly check no longer finds it. jira is { state, siteId } of the workspace's connection, or null without one; an issue of another site, or any issue while the connection needs a new sign in, shows its last known state. 401 without a valid token or session. 403 when the token lacks conversations:read, the caller may not read the ticket, or the plan's monthly cap locks it. 404 when the ticket is not found or is older than the plan's history window. 409 not_a_ticket.

Auth: Bearer token (conversations:read) or session

Link an existing Jira issue by its key. Deskwoot reads the issue with the workspace's Jira connection, links it once and then writes a link back to the ticket in Jira. 201 { issue } for a new link, 200 { issue } when it was linked already.

Auth: Bearer token (conversations:write) or session (conversations.manage)

Unlink an issue (its id from the GET above) and remove the link back to the ticket in Jira. The issue stays in Jira. Answers { success: true }; 404 not_linked; 403 and 409 tickets_disabled as for linking; 409 jira_not_connected or jira_reauth_required, so Jira and Deskwoot do not disagree about the link.

Auth: Bearer token (conversations:write) or session (conversations.manage)

List contacts with optional search and segment filtering. Supports pagination.

Auth: Bearer token (contacts:read) or session

Get one contact with its notes, addresses and latest conversations. Like the list, it carries verified, and for an API token verifiedIdentifier (the user id your site signed for Identity Verification). The identifier field is the contact's own identifier, set when the contact was created.

Auth: Bearer token (contacts:read) or session

Create a contact. Needs a name or an email. An email another contact has answers 409 with its contactId; an identifier or telegramId another contact has answers 409 with code identifier_taken or telegram_id_taken and that contact's id. Answers 201 with the contact.

Auth: Bearer token (contacts:write) or session (permission: contacts.manage)

Change the fields you send (the fields of the create except identifier, plus tags, locale and blocked); null clears one, and custom attributes merge (null removes a key). telegramId can be set only while the contact has none (400 with reason locked otherwise); an email or telegramId another contact has answers 409 with code email_taken or telegram_id_taken.

Auth: Bearer token (contacts:write) or session (permission: contacts.manage)

Merge two contact records into one. The primary contact keeps its data; the secondary contact's conversations are moved over.

Auth: Bearer token (contacts:write) or session

List organizations from A to Z, each with the number of its contacts. With search, organizations named exactly as searched (apart from case) come first. Supports pagination.

Auth: Bearer token (contacts:read) or session

Create an organization. A name or domain another organization of the workspace already has (apart from case) answers 409 with code name_taken or domain_taken and that organization's id.

Auth: Bearer token (contacts:write) or session (permission: contacts.manage)

Get one organization with a page of its contacts (50 per page, A to Z, each with the number of its conversations) and its 20 most recent conversations, plus _count.contacts and _count.conversations. Pass contactsPage for the next page of contacts, and contactsOnly=true to leave the conversations and _count.conversations out. A token without conversations:read gets no conversations and no _count.conversations, on the organization or on its contacts.

Auth: Bearer token (contacts:read) or session

Change the fields you send (the same fields as the create); null clears one, the name cannot be cleared. Answers 409 like the create.

Auth: Bearer token (contacts:write) or session (permission: contacts.manage)

Delete an organization. Its contacts and their conversations stay; they no longer belong to an organization.

Auth: Session (permission: contacts.delete)

Make a Telegram, LINE or WhatsApp group chat (the contact is the group) an organization. The group joins it. Teammates, recognized by the Telegram they connected under Settings > Notifications, are left out. Anyone else who wrote in the group joins when they are a contact of their own (on LINE and WhatsApp: people who also chat with you directly) and have no organization yet, also a contact a group added before and an agent took out; blocked contacts stay out. Send name to create a new organization, or organizationId to add the group to an existing one. Answers the organization, created and linked (how many contacts joined, the group among them), with 201 for a new organization. A name another organization has answers 409 with code name_taken, that organization's id and its name; a group that already has an organization answers 409 with code has_organization; a contact that is no group chat answers 400 with code not_a_group.

Auth: Bearer token (contacts:write) or session (permission: contacts.manage)

List all inboxes in your account.

Auth: Bearer token (read) or session

Create a new inbox. Supported channel types: WEB, EMAIL, TELEGRAM, WHATSAPP, SMS, LINE, TWITTER.

Auth: Session (permission: settings.manage_inboxes)

Get full details for a single inbox.

Auth: Bearer token (read) or session

Update inbox settings such as name, greeting, auto-assign mode, CSAT, business hours, widget color, and bot configuration.

Auth: Session (permission: settings.manage_inboxes)

Delete an inbox and all associated data. This action cannot be undone.

Auth: Session (permission: settings.manage_inboxes)

List all agents (team members) in your account, including their role and custom role.

Auth: Bearer token (read) or session

Invite a new agent to your account. An invitation email is sent automatically.

Auth: Session (admin only)

Update an agent's role.

Auth: Session (admin only)

Remove an agent from your account.

Auth: Session (admin only)

List all teams with their member count.

Auth: Bearer token (read) or session

Create a new team.

Auth: Session (permission: settings.manage_teams)

Get a team with its full member list.

Auth: Bearer token (read) or session

Update team name, description, or auto-assign setting.

Auth: Session (permission: settings.manage_teams)

Delete a team.

Auth: Session (permission: settings.manage_teams)

Add an agent to a team.

Auth: Session (permission: settings.manage_teams)

Remove an agent from a team.

Auth: Session (permission: settings.manage_teams)

List all labels in your account.

Auth: Bearer token (read) or session

Create a new label.

Auth: Session (permission: settings.manage_labels)

Update a label's title, color, description, or visibility.

Auth: Session (permission: settings.manage_labels)

Delete a label. It will be removed from all conversations.

Auth: Session (permission: settings.manage_labels)

List all canned responses.

Auth: Bearer token (read) or session

Create a canned response. Agents can use it by typing the short code in the message input.

Auth: Session (permission: settings.manage_canned_responses)

Expand the variables of a canned response for one conversation and return the text ready to send. The agent variables resolve to the calling user (for API tokens: the token owner). Returns { content }.

Auth: Bearer token (scope: conversations:read) or session

Update a canned response.

Auth: Session (permission: settings.manage_canned_responses)

Delete a canned response.

Auth: Session (permission: settings.manage_canned_responses)

List all public macros and your personal macros.

Auth: Bearer token (read) or session

Create a new macro with one or more actions.

Auth: Bearer token (write) or session

Update a macro.

Auth: Bearer token (write) or session

Delete a macro.

Auth: Bearer token (write) or session

List all automation rules.

Auth: Bearer token (read) or session

Create an automation rule with conditions and actions.

Auth: Session (permission: settings.manage_automation)

Update an automation rule.

Auth: Session (permission: settings.manage_automation)

Delete an automation rule.

Auth: Session (permission: settings.manage_automation)

List all campaigns (ongoing and one-off).

Auth: Bearer token (read) or session

Create a new campaign.

Auth: Session (permission: settings.manage_campaigns)

Get campaign details.

Auth: Bearer token (read) or session

Update a campaign.

Auth: Session (permission: settings.manage_campaigns)

Send a one-off campaign immediately.

Auth: Session (permission: settings.manage_campaigns)

Delete a campaign.

Auth: Session (permission: settings.manage_campaigns)

List all webhooks. Secrets are redacted to their first 4 characters.

Auth: Session or API token (scope: read), account member

Create a webhook. A signing secret is generated automatically and returned once in the response.

Auth: Session or API token (scope: write), administrator role

Update a webhook's URL, subscriptions or enabled flag. Below the Startup plan it answers 403 with the code feature_not_in_plan, like creating one.

Auth: Session (administrator role)

Delete a webhook.

Auth: Session (administrator role)

List all API tokens. The actual token value is not included for security.

Auth: Session (admin only)

Create a new API token. The token value is only shown once in the response.

Auth: Session (admin only)

Revoke an API token. It will immediately stop working.

Auth: Session (admin only)

List all AI bots. API keys are masked in the response.

Auth: Bearer token (read) or session

Create a new AI bot.

Auth: Session (permission: bots.manage)

Update a bot's settings.

Auth: Session (permission: bots.manage)

Delete a bot.

Auth: Session (permission: bots.manage)

Test a bot's response with a sample message.

Auth: Session (permission: bots.manage)

List custom attribute definitions. Use ?model=CONVERSATION or ?model=CONTACT to filter.

Auth: Bearer token (conversations:read or contacts:read) or session

Create a custom attribute definition.

Auth: Session (admin only)

Update a custom attribute's display name, type, description or list options. Key and model cannot change.

Auth: Session (admin only)

Delete a custom attribute.

Auth: Session (admin only)

List all custom roles with their permissions.

Auth: Session (admin only)

Create a custom role with granular permissions.

Auth: Session (admin only)

Update a custom role.

Auth: Session (admin only)

Delete a custom role.

Auth: Session (admin only)

All headline numbers for the period and filters, plus the number of matching conversations of all time.

Auth: Bearer token (conversations:read) or session

The same metrics per group. Groups without activity are included with zeros, so quiet agents and unused labels show up. An agent group holds the conversations that agent worked on in the period, so agent groups overlap and do not add up to the totals; the group without a key, Unassigned, holds the period's conversations nobody worked on. Agent groups are agent scoped: firstResponse is the agent's own first response and replyTime their reply times. Day and week buckets follow the timezone; weeks start on Monday. The CSV keeps its columns in place; the reply_time_* columns follow and stay empty when the result is not agent scoped, then the reopen and backlog columns, then escalations, escalated_out and the time_in_team_* columns (backlog and team moves empty for a day or week), then the next_response_* columns, then the sla_* columns (achieved, breached and compliance per metric, conversations and tickets together).

Auth: Bearer token (conversations:read) or session

One row per conversation of the period with every fact the reports are built from: status, priority, subject, agent (the current assignee), team, inbox, channel, labels, first reply and first response, resolution time, CSAT rating and feedback, country and, with contacts:read, the contact. firstReplyAt and firstResponseSeconds are the conversation's first reply and the customer's wait; with agent_id (the conversations the agent worked on in the period) or for a member who is no administrator, they are the agent's own first reply to a waiting customer and its wait, empty when the agent gave none. agentFirstResponses, last in each row, lists each agent's own first response with seconds, repliedAt and assignedAt. Newest first. With slice, the rows are the conversations behind one number of the summary, counted the same way, and each row ends with openSince (since when a backlog row is open, null outside the backlog slices) and sliceEvents (how often the row counts in a reopened or sla slice, null in any other); the first page adds total (the conversations of the slice) and, for reopened and sla, events (the reopens or SLA outcomes they hold, the number the summary shows). The CSV of a slice appends open_since and slice_events after agent_first_responses. Without slice the answer is what it always was.

Auth: Bearer token (conversations:read) or session

One row per reply that counts in the agent response times: a person answering a customer who was waiting, sent in the period. Each row has messageId, conversation, agent, repliedAt, waitingSince (the oldest customer message still unanswered), assignedAt (when the agent got the conversation; null when they took it by answering), agentWaitSeconds, customerWaitSeconds (queue time included), firstForAgent, inbox and team. agent_id picks whose replies are listed; the other filters apply to the conversation. Newest first. A member who is no administrator gets only their own replies in the conversations assigned to them.

Auth: Bearer token (conversations:read) or session

CSAT totals and star distribution, the numbers per agent (the agent the survey was sent for) and every survey of the period with rating, feedback, agent, conversation, inbox, team and, with contacts:read, the contact. A survey that waited for the conversation's open tickets names the ticket whose resolve sent it in ticketId (null otherwise).

Auth: Bearer token (conversations:read) or session

Help center article votes (helpful and not helpful) per article in the period. Reads the period parameters only.

Auth: Bearer token (help_center:read) or session

The CSV downloads of the Reports page: type=conversations, agents or csat with range=7d, 30d or 90d. For type=conversations, kind=conversations (the default), tickets or all says what the file holds, as the Reports page's Type switch; with tickets the file gets the columns Type, Title, Category and Source Conversation ID after the published ones, and a ticket's Inbox is empty. An unknown kind answers 400. The agents file has one row per person and keeps its first six columns in place: Agent Name, Email, Role, Conversations (worked on in the range), Resolved, Avg Response Time (min) (the agent's own first response in whole minutes, empty when there is none). Then come Replies, Picked Up Replies, First Response Avg, Median and P90, Reply Time Avg and Median (in seconds), CSAT Score and CSAT Responses; format=json returns the same numbers.

Auth: Bearer token (conversations:read) or session

List all SLA policies with conversation counts.

Auth: Bearer token (read) or session

Create an SLA policy.

Auth: Session (admin only)

Update an SLA policy. Takes the same fields as POST, priorityTargets and businessHoursScheduleId included; a field left out stays as it is.

Auth: Session (admin only)

Delete an SLA policy.

Auth: Session (admin only)

The schedules by name: id, name, timezone, schedule (the 7 days) and _count with the teams and policies that use each.

Auth: Session (permission: settings.manage_teams)

Add a schedule. 409 schedule_limit at 20 schedules, 409 schedule_name_taken when the name exists already. A refused time answers 400 with a code and the field's path.

Auth: Session (admin only), plan with SLA policies

Change a schedule's name, timezone or days; the fields left out stay. The clocks that count in it follow at their next read. 409 schedule_name_taken when the name exists already.

Auth: Session (admin only), plan with SLA policies

Delete a schedule. The teams and policies that used it lose it, and their clocks count in the next schedule of the order. Works without the plan, so a workspace can tidy up after a downgrade.

Auth: Session (admin only)

Get your account's business hours configuration.

Auth: Bearer token (read) or session

Set business hours. Provide the full schedule.

Auth: Session (permission: settings.manage_account)

List your help center portals with article and category counts.

Auth: Bearer token (help_center:read) or session

Create a new help center portal.

Auth: Bearer token (help_center:write) or session

Update portal settings, including which languages it offers translations in.

Auth: Bearer token (help_center:write) or session

List articles in a portal.

Auth: Bearer token (help_center:read) or session

Create a new help center article.

Auth: Bearer token (help_center:write) or session

Update an article, including its per-language translations object. A new slug moves every language row of the article (the rows that share its slug) with it; 409 with code slug_taken when another article already uses that slug in one of those languages. A move that makes an internal article public (its last row in an internal category moved to a public one) needs confirmPublic set to true; without it the request changes nothing and answers 409 with code confirm_public and articles, the number of articles it would publish.

Auth: Bearer token (help_center:write) or session

Delete an article.

Auth: Bearer token (help_center:write) or session

List categories in a portal, ordered by position.

Auth: Bearer token (help_center:read) or session

Create a category. Every article must belong to a category, so create one before creating articles.

Auth: Bearer token (help_center:write) or session

Update a category, including who may read it.

Auth: Bearer token (help_center:write) or session

Get public portal info with categories and article count.

Auth: None

List published articles. Supports search and pagination.

Auth: None

Get a single published article by slug, with its title, body, and SEO fields in the requested language.

Auth: None

Get account settings including name, locale, timezone, plan, and feature flags.

Auth: Bearer token (read) or session

Update account settings.

Auth: Session (permission: settings.manage_account)

Get paginated notifications for the current user.

Auth: Session only

Mark notifications as read.

Auth: Session only

Get paginated audit logs for your account. Admin only.

Auth: Session (admin only)

Get billing information for your account.

Auth: Session (permission: settings.manage_billing)

Get the unified AI conversation meter, prepaid balance, and auto-recharge config. One conversation counts at most once per calendar month, regardless of whether the live-chat bot answered, an agent ran a Copilot action, or both. Answers in the help center search count 1 for a visitor's first question of the month and 0.25 for each further one, so conversationsUsed and overageConversations can hold quarters such as 12.25.

Auth: Session (member of account)

Update auto-recharge settings. The legacy addBalance field is rejected with 410 Gone, top-ups must go through /v1/stripe/topup so Stripe is the source of truth for balance increments.

Auth: Session (permission: ADMINISTRATOR)