> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Unthread

> How to set up the Unthread connector, plus the actions that are available.

![Unthread](https://stackone-logos.com/api/unthread/filled/svg)

Betav0.2.0[See changelog](https://docs.stackone.com/connectors/unthread/changelog.md)

[70 actions](#actions) · 1 auth method

Customer Support

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/unthread/guides/connector-profile/api-key.md)
>
> Unthread authenticates with a Service Account key sent in the \`X-Api-Key\` header. The key is created in the Unthread das...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/unthread/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

70 actions

ActionDescription

Create Account`unthread_create_account`

Create a new account (a company or organization record) that groups related customers and support activity in Unthread.

Get Account`unthread_get_account`

Retrieve the full details of a single account by its unique ID.

Update Account`unthread_update_account`

Update the details of an existing account, such as its name, primary support assignee type, or support workflow steps.

Delete Account`unthread_delete_account`

Permanently delete an account by its ID.

List Accounts`unthread_list_accounts`

List accounts in the workspace with optional filtering, sorting, field selection, and cursor-based pagination.

Create Approval Request`unthread_create_approval_request`

Create an approval request on a conversation, optionally assigning it to a specific user or group for sign-off.

List Approval Requests`unthread_list_approval_requests`

List all approval requests attached to a specific conversation.

Create Automation`unthread_create_automation`

Create an automation workflow that runs a sequence of steps when a trigger fires.

Create Automation Function`unthread_create_automation_function`

Upload automation function source code for a project, creating a new function version.

Activate Automation Function`unthread_activate_automation_function`

Activate a specific automation function version for a project.

List Collaborator Types`unthread_list_collaborator_types`

List the collaborator types defined in the workspace, with optional filtering, sorting, field selection, and cursor pagi...

Create Conversation`unthread_create_conversation`

Create a new conversation (support ticket) in Unthread, optionally linking it to a customer, assignee, and ticket type....

Get Conversation`unthread_get_conversation`

Retrieve the full record of a single conversation by its ID, including its status, priority, assignee, and metadata. Use...

Update Conversation`unthread_update_conversation`

Update an existing conversation's status, priority, assignee, ticket-type field values, or metadata. Use this to progres...

List Conversations`unthread_list_conversations`

List conversations (support tickets) with optional filtering, sorting, field selection, and cursor pagination. Use this...

Create Conversation Message`unthread_create_conversation_message`

Add a reply message or internal private note to a conversation. Use this to respond to a customer or leave an agent-only...

List Conversation Messages`unthread_list_conversation_messages`

List the messages in a conversation thread, with optional filtering, sorting, field selection, and cursor pagination. Us...

Add Conversation Follower`unthread_add_conversation_follower`

Add a follower (a user or group) to a conversation so they receive updates on the ticket. Use this to loop additional pe...

Remove Conversation Follower`unthread_remove_conversation_follower`

Remove a follower from a conversation so they stop receiving updates on the ticket. Use this to reverse add\_conversation...

Assign Conversation Collaborator`unthread_assign_conversation_collaborator`

Assign a collaborator (a user or group) of a specific collaborator type to a conversation. Use this to attach helpers in...

Link Conversations`unthread_link_conversations`

Create a link between two conversations to relate them (for example duplicates or related tickets). Use this to connect...

Create Conversation External Task`unthread_create_conversation_external_task`

Create an external task (for example a linked issue in Jira, Linear, or another connected tool) from a conversation. Use...

Download Conversation File`unthread_download_conversation_file`

Download the full content of a file attachment from a conversation. Use this to retrieve documents or images customers o...

List Conversation SLA Instances`unthread_list_conversation_sla_instances`

List the SLA instances (deadlines and their status) tracked for a conversation, with optional filtering and cursor pagin...

Create Customer`unthread_create_customer`

Create a new customer (the company or end-user account you support) with an optional Slack channel link, email domains,...

Get Customer`unthread_get_customer`

Retrieve the full record for a single customer by its unique ID.

Update Customer`unthread_update_customer`

Update an existing customer's details, such as its display name, autoresponder, support workflow steps, or bot handling...

Delete Customer`unthread_delete_customer`

Permanently delete a customer by its unique ID.

List Customers`unthread_list_customers`

List customers with optional filtering, sorting, field selection, and automatic cursor pagination.

Query Knowledge Base`unthread_query_knowledge_base`

Run a natural-language query against the knowledge base to surface relevant articles or answers.

Create Knowledge Base Article`unthread_create_kb_article`

Create a new knowledge base article with a title and body content.

Get Knowledge Base Article`unthread_get_kb_article`

Retrieve a single knowledge base article by its ID.

Update Knowledge Base Article`unthread_update_kb_article`

Update the title, content, status, or scope of an existing knowledge base article.

Delete Knowledge Base Article`unthread_delete_kb_article`

Permanently delete a knowledge base article by its ID.

List Knowledge Base Articles`unthread_list_kb_articles`

List knowledge base articles with optional filtering, sorting, field selection, and cursor pagination.

Create Outbound Message`unthread_create_outbound`

Create a proactive outbound message to send to customers, either immediately, as a draft, or scheduled for a future time...

Update Outbound Message`unthread_update_outbound`

Update the content, recipients, or status of an existing outbound message, typically one still in draft or scheduled.

Get Outbound Message`unthread_get_outbound`

Retrieve the full details of a single outbound message by its ID, including content, recipients, status, and schedule.

List Outbound Messages`unthread_list_outbounds`

List all outbound messages in the workspace, including drafts, scheduled, and sent messages.

Get Time Series Report`unthread_get_time_series_report`

Get a time-series report of conversation metrics bucketed over a date range, for dashboards and trend analysis.

Create SLA Policy`unthread_create_sla_policy`

Create a service-level agreement (SLA) policy with one or more target metrics.

List SLA Policies`unthread_list_sla_policies`

List SLA policies with optional filtering, sorting, field selection, and cursor pagination.

Get SLA Policy`unthread_get_sla_policy`

Retrieve a single SLA policy by its ID.

Update SLA Policy`unthread_update_sla_policy`

Update the name, status, or metrics of an existing SLA policy.

Delete SLA Policy`unthread_delete_sla_policy`

Permanently delete an SLA policy by its ID.

List SLA Instances`unthread_list_sla_instances`

List SLA instances (individual deadlines and their status) across the workspace with optional filtering.

Update Slack User Group`unthread_update_slack_usergroup`

Update the Slack user group mapping for a user, associating an Unthread user with a Slack handle or user group. Use this...

List Surveys`unthread_list_surveys`

List customer-satisfaction surveys with optional filtering, sorting, field selection, and cursor pagination.

List Survey Responses`unthread_list_survey_responses`

List the individual responses submitted for a specific survey, with optional filtering, sorting, and cursor pagination.

Get Survey Analytics`unthread_get_survey_analytics`

Get aggregated analytics for a survey, such as overall CSAT scores, rather than individual responses.

Create Tag`unthread_create_tag`

Create a new tag that can later be applied to customers and conversations for labeling and filtering.

Get Tag`unthread_get_tag`

Retrieve the full details of a single tag by its unique ID.

Update Tag`unthread_update_tag`

Rename an existing tag identified by its ID.

Delete Tag`unthread_delete_tag`

Permanently delete a tag by its ID, removing it from all customers and conversations it was applied to.

List Tags`unthread_list_tags`

List tags in the workspace with optional filtering, sorting, field selection, and cursor-based pagination.

Add Tag To Customers`unthread_add_tag_to_customers`

Link a tag to one or more customers so those customers become filterable by that tag.

Add Tag To Conversations`unthread_add_tag_to_conversations`

Link a tag to one or more conversations so those conversations become filterable by that tag.

Remove Tag From Customers`unthread_remove_tag_from_customers`

Unlink a tag from one or more customers without deleting the tag itself.

Remove Tag From Conversations`unthread_remove_tag_from_conversations`

Unlink a tag from one or more conversations without deleting the tag itself.

Create Ticket Type`unthread_create_ticket_type`

Create a new ticket type whose custom fields define the intake form applied to conversations of that type.

Get Ticket Type`unthread_get_ticket_type`

Retrieve the full record for a single ticket type by its unique ID.

Update Ticket Type`unthread_update_ticket_type`

Update an existing ticket type's name, description, or the custom fields that make up its conversation form.

Delete Ticket Type`unthread_delete_ticket_type`

Permanently delete a ticket type by its unique ID.

List Ticket Types`unthread_list_ticket_types`

List ticket types with optional filtering, sorting, field selection, and automatic cursor pagination.

List User Groups`unthread_list_user_groups`

List user groups with optional filtering, sorting, field selection, and cursor pagination.

Get User Group`unthread_get_user_group`

Retrieve the full details of a single user group by its ID, including its description and membership filters.

Update User Group`unthread_update_user_group`

Update an existing user group's description or membership filters.

List Users`unthread_list_users`

List workspace users with optional filtering, sorting, field selection, and cursor pagination; can optionally include ex...

Get User`unthread_get_user`

Retrieve the full profile of a single user by its ID.

Update User`unthread_update_user`

Update the profile of an existing user, such as their display name, title, pronouns, photo, or custom attributes.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.