assign_conversation
ChatGPTAssign a team member to a conversation.
create_conversation
ChatGPTCreate a new conversation with a customer.
create_customer
ChatGPTCreate a new customer in the organization (fails with 409 if the email is already a customer; use list_customers to find them). Requires a user-delegated (actor=self) token; app tokens get 422 actor_self_required.
create_message
ChatGPTSend a customer-visible reply in a conversation. body_html must be HTML — wrap plain text in <p> tags. Requires a user-authorized (actor=self) token; app tokens fail with 422 actor_self_required.
create_note
ChatGPTAdd an internal note to a conversation. Notes are visible only to the team, never to the customer (use create_message to reply). body_html must be HTML — wrap plain text in <p> tags. Requires a user-authorized (actor=self) token; app tokens fail with 422 actor_self_required.
create_segment
ChatGPTCreate a segment: a saved filter over customers/contacts (not an inbox view).
create_task
ChatGPTCreate a task. Requires the Tasks module to be enabled for the organization.
delete_message
ChatGPTPermanently delete one of your own messages from a conversation. Requires a user-authorized (actor=self) token; app tokens fail with 422 actor_self_required.
delete_segment
ChatGPTPermanently delete a segment. Customers in it are not affected.
delete_task
ChatGPTPermanently delete a task. Requires the Tasks module to be enabled for the organization.
get_conversation
ChatGPTGet full details of a single conversation by its ID.
get_customer
ChatGPTGet full details of a single customer by their user ID.
get_organization
ChatGPTGet the current organization: id, name, display_name, domain, created_at.
get_organization_settings
ChatGPTGet the current organization settings: locale, languages, guest and AI options, bot configuration, business hours, and feature flags. Credentials are never returned.
get_segment
ChatGPTGet a single segment (saved customer filter) by ID.
get_task
ChatGPTGet a single task by ID. Requires the Tasks module to be enabled for the organization.
get_team_member
ChatGPTGet details of a specific team member by their membership ID.
invite_team_member
ChatGPTAdd a team member to the organization with the given role. The email must belong to an existing SupportWire user. Requires an admin's user-delegated (actor=self) token; app tokens get 422 actor_self_required.
list_conversation_filter_options
ChatGPTList the values list_conversations accepts for its filters and sort. Returns the enum sets (statuses, types, priority/urgency levels and ops, issue types, sort) plus assignees (team members: id, name, email). Pass an assignee id in assignee_ids, or "unassigned" for conversations with no assignee.
list_conversations
ChatGPTList conversations with filters, sorting, and cursor pagination. Returns conversations plus page_metadata {after, before, has_more, total_count}. If has_more is true, call again with after=page_metadata.after. Discover valid filter values (assignees, enums) with list_conversation_filter_options.
list_customers
ChatGPTList customers (organization interactors) in the organization with cursor-based pagination. Returns customer records including user name, email, blocked status, and source information, plus page_metadata {after, before, has_more, total_count}. If has_more is true, call again with after=page_metadata.after; never guess cursors. No search/filter params exist; results are ordered by most recently updated.
list_messages
ChatGPTList the customer-facing messages in a conversation (internal notes excluded; use list_notes). Returns messages plus page_metadata {after, before, has_more, total_count}. If has_more is true, call again with after=page_metadata.after and the same order.
list_notes
ChatGPTList internal notes on a conversation, oldest first. Notes are team-only and never visible to the customer. Returns notes plus page_metadata {after, before, has_more, total_count}. If has_more is true, call again with after=page_metadata.after.
list_segments
ChatGPTList segments: saved customer/contact filters (not inbox or conversation views). Returns each segment's name, description, type and filter tree, plus page_metadata.
list_tasks
ChatGPTList tasks in the organization (internal to-dos, optionally linked to a conversation). Requires the Tasks module to be enabled for the organization. Returns tasks with status, due_date, conversation_id, created_by and assignees, plus page_metadata. Pass page_metadata.after as after for the next page.
list_team_members
ChatGPTList team members in the organization. Returns membership IDs, roles, and user details. Use the returned membership IDs when updating or removing team members.
remove_team_member
ChatGPTRemove a team member from the organization. This permanently removes the member. Use update_team_member with archived=true to deactivate instead. Requires an admin's user-delegated (actor=self) token.
unassign_conversation
ChatGPTRemove the assignee from a conversation.
update_conversation
ChatGPTUpdate an existing conversation's status, spam flag, or pinned state.
update_customer
ChatGPTBlock/unblock or star/unstar a customer. Name and email cannot be changed via the API.
update_message
ChatGPTReplace a message body (overwrites the previous HTML). body_html must be HTML — wrap plain text in <p> tags. Only your own messages can be edited. Requires a user-authorized (actor=self) token; app tokens fail with 422 actor_self_required.
update_organization
ChatGPTUpdate the organization's display name. Only the organization owner can do this, with a user-delegated (actor=self) token.
update_organization_settings
ChatGPTUpdate organization settings such as guest submission, AI assistant, bot configuration, and locale.
update_segment
ChatGPTUpdate a segment's name, description, filter or type. Only provided fields change.
update_task
ChatGPTUpdate a task's title, description, status or due date. Only provided fields change. Requires the Tasks module to be enabled for the organization.
update_team_member
ChatGPTChange a team member's role or archive them. Archiving removes their access. Requires an admin's user-delegated (actor=self) token; app tokens get 422.