# Text Documentation ## Docs - [Data and analytics](https://www.text.com/docs/api-overview/data-analytics-apis.md): APIs for reporting, event streams, language detection, and custom properties. - [Management](https://www.text.com/docs/api-overview/management-apis.md): APIs for configuring and managing Text — agents, routing, customer data, and identity. - [Messaging](https://www.text.com/docs/api-overview/messaging-apis.md): APIs for the two sides of a Text conversation — agent and customer. - [Transfer chat](https://www.text.com/docs/api/agent-chat/v3.6/chat-access/transfer-chat.md): Transfers a chat to an agent or a group. - [Add user to chat](https://www.text.com/docs/api/agent-chat/v3.6/chat-users/add-user-to-chat.md): Adds a user to the chat. - [Remove user from chat](https://www.text.com/docs/api/agent-chat/v3.6/chat-users/remove-user-from-chat.md): Removes a user from the chat. - [Deactivate chat](https://www.text.com/docs/api/agent-chat/v3.6/chats/deactivate-chat.md): Deactivates a chat by closing the currently open thread. Sending messages to this thread will no longer be possible. - [Follow chat](https://www.text.com/docs/api/agent-chat/v3.6/chats/follow-chat.md): Marks a chat as followed. All changes to the chat will be sent to the requester until the chat is reactivated or unfollowed. - [Get chat](https://www.text.com/docs/api/agent-chat/v3.6/chats/get-chat.md): Returns a thread that the current agent has access to in a given chat. - [List archives](https://www.text.com/docs/api/agent-chat/v3.6/chats/list-archives.md): Returns a list of the chats an agent has access to. Together with a chat, the events of one thread from this chat are returned. - [List chats](https://www.text.com/docs/api/agent-chat/v3.6/chats/list-chats.md): Returns summaries of the chats an agent has access to. - [List threads](https://www.text.com/docs/api/agent-chat/v3.6/chats/list-threads.md): Returns threads that the current agent has access to in a given chat. - [Resume chat](https://www.text.com/docs/api/agent-chat/v3.6/chats/resume-chat.md): Restarts an archived chat. - [Start chat](https://www.text.com/docs/api/agent-chat/v3.6/chats/start-chat.md): Starts a chat. - [Unfollow chat](https://www.text.com/docs/api/agent-chat/v3.6/chats/unfollow-chat.md): Removes the requester from the chat followers. After that, only key changes to the chat (like `transfer_chat` or `close_active_thread`) will be sent to the requester. - [Ban customer](https://www.text.com/docs/api/agent-chat/v3.6/customers/ban-customer.md): Bans the customer for a specific period of time. It immediately disconnects all active sessions of this customer and does not accept new ones during the ban lifespan. - [Get customer](https://www.text.com/docs/api/agent-chat/v3.6/customers/get-customer.md): Returns the info about the customer with a given `id`. - [Update customer](https://www.text.com/docs/api/agent-chat/v3.6/customers/update-customer.md): Updates customer's properties. Apart from `id`, which is a required parameter, you also need to include at least one of the optional parameters. - [Data structures](https://www.text.com/docs/api/agent-chat/v3.6/data-structures.md): Reference of data structures available in the Agent Chat API v3.6. - [Send event](https://www.text.com/docs/api/agent-chat/v3.6/events/send-event.md): Sends an [event object](/api/agent-chat/v3.6/data-structures#events). Use this method to send a message by specifying the `message` event type in the request. - [Send event preview](https://www.text.com/docs/api/agent-chat/v3.6/events/send-event-preview.md): Sends an event that isn't saved in the chat. Use this method when you're preparing a longer response and want to send a partial update before sending the final message with Send Event. - [Send rich message postback](https://www.text.com/docs/api/agent-chat/v3.6/events/send-rich-message-postback.md): Sends a postback for a rich message event. - [Upload file](https://www.text.com/docs/api/agent-chat/v3.6/events/upload-file.md): Uploads a file to the server as a temporary file. Returns a URL that expires after 24 hours unless the URL is used in `send_event`, in which case it never expires. - [About the Agent Chat API](https://www.text.com/docs/api/agent-chat/v3.6/index.md): Build powerful integrations with an open messaging protocol. - [List agents for transfer](https://www.text.com/docs/api/agent-chat/v3.6/other/list-agents-for-transfer.md): Returns the agents you can transfer a chat to. Agents are sorted ascendingly by the total number of active chats they have. Note that: - [Mark events as seen](https://www.text.com/docs/api/agent-chat/v3.6/other/mark-events-as-seen.md): Marks an agent's events up to a specific time as read in a customer's chat window. - [Multicast](https://www.text.com/docs/api/agent-chat/v3.6/other/multicast.md): Serves for chat-unrelated communication. Messages sent using `multicast` are not being saved. For example, it could be used in an app that sends notifications to agents when a specific condition is met (for instance, when an important customer starts a chat). - [Request thread summary](https://www.text.com/docs/api/agent-chat/v3.6/other/request-thread-summary.md): Requests an AI-generated summary of a specific thread. A deactivated thread can be summarized only once. For active threads, this method can be called multiple times, and the resulting summaries will be delivered as [system events](/messaging/references/system-activities/#summary) inside a thread fo… - [Send thinking indicator](https://www.text.com/docs/api/agent-chat/v3.6/other/send-thinking-indicator.md): Sends a thinking indicator to a chat. - [Send typing indicator](https://www.text.com/docs/api/agent-chat/v3.6/other/send-typing-indicator.md): Sends a typing indicator to a chat. - [Delete chat properties](https://www.text.com/docs/api/agent-chat/v3.6/properties/delete-chat-properties.md): Deletes the properties of a chat. - [Delete event properties](https://www.text.com/docs/api/agent-chat/v3.6/properties/delete-event-properties.md): Deletes the properties of an event. - [Delete thread properties](https://www.text.com/docs/api/agent-chat/v3.6/properties/delete-thread-properties.md): Deletes the properties of a thread. - [Update chat properties](https://www.text.com/docs/api/agent-chat/v3.6/properties/update-chat-properties.md): Updates the properties of a chat. - [Update event properties](https://www.text.com/docs/api/agent-chat/v3.6/properties/update-event-properties.md): Updates the properties of an event. - [Update thread properties](https://www.text.com/docs/api/agent-chat/v3.6/properties/update-thread-properties.md): Updates the properties of a thread. - [Chat access](https://www.text.com/docs/api/agent-chat/v3.6/rtm/chat-access.md): Reference of Chat access methods for the Agent Chat RTM API v3.6. - [Chat users](https://www.text.com/docs/api/agent-chat/v3.6/rtm/chat-users.md): Reference of Chat users methods for the Agent Chat RTM API v3.6. - [Chats](https://www.text.com/docs/api/agent-chat/v3.6/rtm/chats.md): Reference of Chats methods for the Agent Chat RTM API v3.6. - [Customers](https://www.text.com/docs/api/agent-chat/v3.6/rtm/customers.md): Reference of Customers methods for the Agent Chat RTM API v3.6. - [Data structures](https://www.text.com/docs/api/agent-chat/v3.6/rtm/data-structures.md): Reference of data structures available in the Agent Chat API v3.6. - [Events](https://www.text.com/docs/api/agent-chat/v3.6/rtm/events.md): Reference of Events methods for the Agent Chat RTM API v3.6. - [About the Agent Chat RTM API](https://www.text.com/docs/api/agent-chat/v3.6/rtm/index.md): Real-time messaging API for building stateful Text integrations over WebSocket. - [Other](https://www.text.com/docs/api/agent-chat/v3.6/rtm/other.md): Reference of Other methods for the Agent Chat RTM API v3.6. - [Properties](https://www.text.com/docs/api/agent-chat/v3.6/rtm/properties.md): Reference of Properties methods for the Agent Chat RTM API v3.6. - [Pushes](https://www.text.com/docs/api/agent-chat/v3.6/rtm/pushes.md): Reference of push messages for the Agent Chat RTM API v3.6. - [Status](https://www.text.com/docs/api/agent-chat/v3.6/rtm/status.md): Reference of Status methods for the Agent Chat RTM API v3.6. - [Thread tags](https://www.text.com/docs/api/agent-chat/v3.6/rtm/thread-tags.md): Reference of Thread tags methods for the Agent Chat RTM API v3.6. - [List routing statuses](https://www.text.com/docs/api/agent-chat/v3.6/status/list-routing-statuses.md): Returns the current routing status of each agent selected by the provided filters. - [Set routing status](https://www.text.com/docs/api/agent-chat/v3.6/status/set-routing-status.md): Changes the status of an agent or a bot agent. - [Tag thread](https://www.text.com/docs/api/agent-chat/v3.6/thread-tags/tag-thread.md): Tags a given thread. Read how to [list all available tags](/management/configuration-api/v3.6#list-tags) and [create a new tag](/management/configuration-api/v3.6#create-tag). - [Untag thread](https://www.text.com/docs/api/agent-chat/v3.6/thread-tags/untag-thread.md): Untags a given thread. - [Changelog](https://www.text.com/docs/api/changelog.md): Version history for all Text APIs. - [Adapter core](https://www.text.com/docs/api/chat-widget-adapters/adapters-core.md): The core implementation shared between each framework's specific adapter is distributed as a separate library. - [Angular Adapter](https://www.text.com/docs/api/chat-widget-adapters/angular-adapter.md): Check the library which allows rendering and interacting with the chat widget inside an Angular application. - [Overview](https://www.text.com/docs/api/chat-widget-adapters/overview.md): The Chat Widget Adapters allow you to use the chat widget with popular frontend frameworks. - [React Adapter](https://www.text.com/docs/api/chat-widget-adapters/react-adapter.md): Learn about the library that allows rendering and interaction with the chat widget inside a React application. - [Vue Adapter](https://www.text.com/docs/api/chat-widget-adapters/vue-adapter.md): Check the library that allows rendering and interaction with the chat widget inside a Vue application. - [Approve agent](https://www.text.com/docs/api/configuration/v3.6/agents/approve-agent.md): Approves an agent, allowing the agent to use the application. This method is not yet available for public use. Can be [sent in batch](/api/configuration/v3.6/batch-requests). - [Create agent](https://www.text.com/docs/api/configuration/v3.6/agents/create-agent.md): Creates a new agent with specified parameters within a license. Can be [sent in batch](/api/configuration/v3.6/batch-requests). - [Delete agent](https://www.text.com/docs/api/configuration/v3.6/agents/delete-agent.md): Deletes an agent specified by `id`. Can be [sent in batch](/api/configuration/v3.6/batch-requests). - [Get agent](https://www.text.com/docs/api/configuration/v3.6/agents/get-agent.md): Returns the info about an agent specified by `id`. - [List agents](https://www.text.com/docs/api/configuration/v3.6/agents/list-agents.md): Returns all agents within a license. - [Request agent unsuspension](https://www.text.com/docs/api/configuration/v3.6/agents/request-agent-unsuspension.md): Sends emails to license owners and vice owners with an unsuspension request. Can be used by a suspended agent. - [Suspend agent](https://www.text.com/docs/api/configuration/v3.6/agents/suspend-agent.md): Suspends an agent specified by `id`. This method is not yet available for public use. Can be [sent in batch](/api/configuration/v3.6/batch-requests). - [Unsuspend agent](https://www.text.com/docs/api/configuration/v3.6/agents/unsuspend-agent.md): Unsuspends an agent specified by `id`. This method is not yet available for public use. Can be [sent in batch](/api/configuration/v3.6/batch-requests). - [Update agent](https://www.text.com/docs/api/configuration/v3.6/agents/update-agent.md): Updates the properties of an agent specified by `id`. Can be [sent in batch](/api/configuration/v3.6/batch-requests). - [Add auto access](https://www.text.com/docs/api/configuration/v3.6/auto-access/add-auto-access.md): Creates an auto access rule. - [Delete auto access](https://www.text.com/docs/api/configuration/v3.6/auto-access/delete-auto-access.md): Deletes an existing auto access data structure specified by its ID. - [List auto accesses](https://www.text.com/docs/api/configuration/v3.6/auto-access/list-auto-accesses.md): Returns all existing auto access data structures. - [Update auto access](https://www.text.com/docs/api/configuration/v3.6/auto-access/update-auto-access.md): Updates an existing auto access rule. - [Sending batch requests](https://www.text.com/docs/api/configuration/v3.6/batch-requests.md): Manage multiple agents or bots in a single request using batch methods. - [Create bot](https://www.text.com/docs/api/configuration/v3.6/bots/create-bot.md): Creates a new bot. To make the bot available for receiving chats or webhooks, use the Set Routing Status method. Can be [sent in batch](/api/configuration/v3.6/batch-requests). - [Create bot template](https://www.text.com/docs/api/configuration/v3.6/bots/create-bot-template.md): Creates a bot template for the Client ID provided in the request. - [Delete bot](https://www.text.com/docs/api/configuration/v3.6/bots/delete-bot.md): Deletes a bot specified by `id`. Can be [sent in batch](/api/configuration/v3.6/batch-requests). - [Delete bot template](https://www.text.com/docs/api/configuration/v3.6/bots/delete-bot-template.md): Deletes a bot template. - [Get bot](https://www.text.com/docs/api/configuration/v3.6/bots/get-bot.md): Returns the info about a bot with a given `id`. - [Issue bot token](https://www.text.com/docs/api/configuration/v3.6/bots/issue-bot-token.md): Issues a new token for the bot. - [List bot templates](https://www.text.com/docs/api/configuration/v3.6/bots/list-bot-templates.md): Returns the list of bot templates created for a Client ID (application). - [List bots](https://www.text.com/docs/api/configuration/v3.6/bots/list-bots.md): Returns the list of bots created within a license. - [Reset bot secret](https://www.text.com/docs/api/configuration/v3.6/bots/reset-bot-secret.md): Resets the secret for a given bot. - [Reset bot template secret](https://www.text.com/docs/api/configuration/v3.6/bots/reset-bot-template-secret.md): Resets the secret for a given bot template. - [Update bot](https://www.text.com/docs/api/configuration/v3.6/bots/update-bot.md): Updates an existing bot. Can be [sent in batch](/api/configuration/v3.6/batch-requests). - [Update bot template](https://www.text.com/docs/api/configuration/v3.6/bots/update-bot-template.md): Updates an existing bot template. - [List customer bans](https://www.text.com/docs/api/configuration/v3.6/customer-bans/list-customer-bans.md): Returns all active bans for a customer. - [Unban customer](https://www.text.com/docs/api/configuration/v3.6/customer-bans/unban-customer.md): Lifts a ban from a customer. - [Create greeting](https://www.text.com/docs/api/configuration/v3.6/greetings/create-greeting.md): Creates a new greeting. - [Delete greeting](https://www.text.com/docs/api/configuration/v3.6/greetings/delete-greeting.md): Deletes a greeting. - [Get greeting](https://www.text.com/docs/api/configuration/v3.6/greetings/get-greeting.md): Returns the details of a specific greeting. - [List greetings](https://www.text.com/docs/api/configuration/v3.6/greetings/list-greetings.md): Returns a list of greetings. - [Update greeting](https://www.text.com/docs/api/configuration/v3.6/greetings/update-greeting.md): Updates the properties of a greeting. - [Create group](https://www.text.com/docs/api/configuration/v3.6/groups/create-group.md): Creates a new group. - [Delete group](https://www.text.com/docs/api/configuration/v3.6/groups/delete-group.md): Deletes an existing group. - [Get group](https://www.text.com/docs/api/configuration/v3.6/groups/get-group.md): Returns details about a group specified by its `id`. - [List groups](https://www.text.com/docs/api/configuration/v3.6/groups/list-groups.md): Lists all the existing groups. - [Update group](https://www.text.com/docs/api/configuration/v3.6/groups/update-group.md): Updates an existing group. - [Check product limits for plan](https://www.text.com/docs/api/configuration/v3.6/other/check-product-limits-for-plan.md): Compares your organization's current resources against a given plan and returns those that exceed its limits. - [Get product source](https://www.text.com/docs/api/configuration/v3.6/other/get-product-source.md): Retrieves the `source` parameters that were passed when activating the Text product. - [List channels](https://www.text.com/docs/api/configuration/v3.6/other/list-channels.md): Returns the summary of communication channels for your Text product. - [Reactivate email](https://www.text.com/docs/api/configuration/v3.6/other/reactivate-email.md): Reactivates email if it has been bounced. - [Update company details](https://www.text.com/docs/api/configuration/v3.6/other/update-company-details.md): Updates company details of the license. - [Delete group properties](https://www.text.com/docs/api/configuration/v3.6/properties/delete-group-properties.md): Deletes the properties set within a group. - [Delete license properties](https://www.text.com/docs/api/configuration/v3.6/properties/delete-license-properties.md): Deletes the properties set within a license. - [List groups properties](https://www.text.com/docs/api/configuration/v3.6/properties/list-groups-properties.md): Returns the properties set within specified groups. - [List license properties](https://www.text.com/docs/api/configuration/v3.6/properties/list-license-properties.md): Returns the properties set within a license. - [List properties](https://www.text.com/docs/api/configuration/v3.6/properties/list-properties.md): Lists private and public properties owned by a given Client Id. - [Publish property](https://www.text.com/docs/api/configuration/v3.6/properties/publish-property.md): Publishes a private property. - [Register property](https://www.text.com/docs/api/configuration/v3.6/properties/register-property.md): Registers a new private property for a given Client Id. - [Unregister property](https://www.text.com/docs/api/configuration/v3.6/properties/unregister-property.md): Unregisters a private property. - [Update group properties](https://www.text.com/docs/api/configuration/v3.6/properties/update-group-properties.md): Updates a property value within a group as the property location. This operation doesn't overwrite the existing values. - [Update license properties](https://www.text.com/docs/api/configuration/v3.6/properties/update-license-properties.md): Updates a property value within a license. This operation doesn't overwrite the existing values. - [Create tag](https://www.text.com/docs/api/configuration/v3.6/tags/create-tag.md): Creates a new tag. - [Delete tag](https://www.text.com/docs/api/configuration/v3.6/tags/delete-tag.md): Deletes an existing tag. - [List tags](https://www.text.com/docs/api/configuration/v3.6/tags/list-tags.md): Lists the existing tags. - [Update tag](https://www.text.com/docs/api/configuration/v3.6/tags/update-tag.md): Updates an existing tag. - [Disable license webhooks](https://www.text.com/docs/api/configuration/v3.6/webhooks/disable-license-webhooks.md): Disables the webhooks on the license. - [Enable license webhooks](https://www.text.com/docs/api/configuration/v3.6/webhooks/enable-license-webhooks.md): Enables webhooks that were disabled via Disable License Webhooks. - [Get license webhooks state](https://www.text.com/docs/api/configuration/v3.6/webhooks/get-license-webhooks-state.md): Returns the state of webhooks registered for a given Client ID on the license associated with the access token. - [List webhook names](https://www.text.com/docs/api/configuration/v3.6/webhooks/list-webhook-names.md): Lists all webhooks that are supported in a given API version. This method requires no authorization. - [List webhooks](https://www.text.com/docs/api/configuration/v3.6/webhooks/list-webhooks.md): Lists all webhooks registered for the given Client ID. - [Register webhook](https://www.text.com/docs/api/configuration/v3.6/webhooks/register-webhook.md): Registers a webhook for the Client ID provided in the request. - [Unregister webhook](https://www.text.com/docs/api/configuration/v3.6/webhooks/unregister-webhook.md): Unregisters a webhook previously registered for a Client ID (application). - [Customer Accounts API](https://www.text.com/docs/api/customer-accounts/index.md): Manage customer authentication and authorization in Text. - [Create a group token](https://www.text.com/docs/api/customer-accounts/tokens/create-a-group-token.md): Creates a new customer access token for a different group within the same organization. Use this token to separate customer identity across groups within one organization. - [Create a token](https://www.text.com/docs/api/customer-accounts/tokens/create-a-token.md): Creates a new customer access token. - [Create an identity transfer token](https://www.text.com/docs/api/customer-accounts/tokens/create-an-identity-transfer-token.md): Creates a new identity transfer token, which can be exchanged for a customer access token. - [Get token details](https://www.text.com/docs/api/customer-accounts/tokens/get-token-details.md): Retrieve information about an access token. You can provide the token via authorization or a query string. - [Revoke token](https://www.text.com/docs/api/customer-accounts/tokens/revoke-token.md): Revoke a token provided via authorization. - [Deactivate chat](https://www.text.com/docs/api/customer-chat/v3.6/chats/deactivate-chat.md): Deactivates a chat by closing the currently open thread. Sending messages to this thread will no longer be possible. - [Get chat](https://www.text.com/docs/api/customer-chat/v3.6/chats/get-chat.md): Returns a thread that the current customer has access to in a given chat. - [List chats](https://www.text.com/docs/api/customer-chat/v3.6/chats/list-chats.md): Returns summaries of the chats a customer participated in. - [List threads](https://www.text.com/docs/api/customer-chat/v3.6/chats/list-threads.md): Returns threads that the current customer has access to in a given chat. - [Resume chat](https://www.text.com/docs/api/customer-chat/v3.6/chats/resume-chat.md): Restarts an archived chat. The method updates the requester's `events_seen_up_to` as if they've seen all chat events. - [Start chat](https://www.text.com/docs/api/customer-chat/v3.6/chats/start-chat.md): Starts a chat. The method updates the requester's `events_seen_up_to` as if they've seen all chat events. - [Get configuration](https://www.text.com/docs/api/customer-chat/v3.6/configuration/get-configuration.md): Returns the configuration of a given group in a given version. Contains data based on which the Chat Widget can be built. - [Get dynamic configuration](https://www.text.com/docs/api/customer-chat/v3.6/configuration/get-dynamic-configuration.md): Returns the dynamic configuration of a given group. It provides data to call Get Configuration and Get Localization. - [Get customer](https://www.text.com/docs/api/customer-chat/v3.6/customers/get-customer.md): Returns the info about the customer requesting it. - [Set customer session fields](https://www.text.com/docs/api/customer-chat/v3.6/customers/set-customer-session-fields.md): User agent and referrer are updated by default using the browser's headers. - [Update customer](https://www.text.com/docs/api/customer-chat/v3.6/customers/update-customer.md): At least one optional parameter needs to be included in the request. - [Data structures](https://www.text.com/docs/api/customer-chat/v3.6/data-structures.md): Reference of data structures available in the Customer Chat API v3.6. - [Delete event](https://www.text.com/docs/api/customer-chat/v3.6/events/delete-event.md): Deletes an [event object](/api/customer-chat/v3.6/data-structures#events). Deleted events are hidden from all Customer Chat API responses but remain visible via the Agent Chat API. - [Send event](https://www.text.com/docs/api/customer-chat/v3.6/events/send-event.md): Sends an [event object](/api/customer-chat/v3.6/data-structures#events). Use this method to send a message by specifying the Message event type in the request. - [Send rich message postback](https://www.text.com/docs/api/customer-chat/v3.6/events/send-rich-message-postback.md): Sends a rich message postback. - [Send sneak peek](https://www.text.com/docs/api/customer-chat/v3.6/events/send-sneak-peek.md): Sends a sneak peek to a chat. - [Upload file](https://www.text.com/docs/api/customer-chat/v3.6/events/upload-file.md): Uploads a file to the server as a temporary file. It returns a URL that expires after 24 hours unless the URL is used in `send_event`. - [About the Customer Chat API](https://www.text.com/docs/api/customer-chat/v3.6/index.md): Interact with Text conversations from the customer's perspective. - [Get localization](https://www.text.com/docs/api/customer-chat/v3.6/localization/get-localization.md): Returns the localization of a given language and group in a given version. Contains translated phrases for the Chat Widget. - [Accept greeting](https://www.text.com/docs/api/customer-chat/v3.6/other/accept-greeting.md): Marks an incoming greeting as seen. - [Cancel greeting](https://www.text.com/docs/api/customer-chat/v3.6/other/cancel-greeting.md): Cancels a greeting (an invitation to the chat). - [Check goals](https://www.text.com/docs/api/customer-chat/v3.6/other/check-goals.md): Triggers checking if goals were achieved. Works only for offline customers. - [Get form](https://www.text.com/docs/api/customer-chat/v3.6/other/get-form.md): Returns an empty ticket form of a prechat or postchat survey. - [Get predicted agent](https://www.text.com/docs/api/customer-chat/v3.6/other/get-predicted-agent.md): Gets the predicted agent — the one the customer will chat with when the chat starts. To use this method, the customer needs to be logged in. - [Get URL info](https://www.text.com/docs/api/customer-chat/v3.6/other/get-url-info.md): Returns the info on a given URL. - [Mark events as seen](https://www.text.com/docs/api/customer-chat/v3.6/other/mark-events-as-seen.md) - [Request email verification](https://www.text.com/docs/api/customer-chat/v3.6/other/request-email-verification.md): Requests the verification of the customer's email address by sending them a verification email with the identity confirmation link. - [Request welcome message](https://www.text.com/docs/api/customer-chat/v3.6/other/request-welcome-message.md): Requests a welcome message from the system. The response contains the predicted agent the customer will chat with once the chat starts. This method requires the customer to be logged in. - [Send greeting button clicked](https://www.text.com/docs/api/customer-chat/v3.6/other/send-greeting-button-clicked.md) - [Delete chat properties](https://www.text.com/docs/api/customer-chat/v3.6/properties/delete-chat-properties.md) - [Delete event properties](https://www.text.com/docs/api/customer-chat/v3.6/properties/delete-event-properties.md) - [Delete thread properties](https://www.text.com/docs/api/customer-chat/v3.6/properties/delete-thread-properties.md) - [List group properties](https://www.text.com/docs/api/customer-chat/v3.6/properties/list-group-properties.md): Returns the properties of a given group. It only returns the properties a customer has access to. - [List license properties](https://www.text.com/docs/api/customer-chat/v3.6/properties/list-license-properties.md): Returns the properties of a given license. It only returns the properties a customer has access to. - [Update chat properties](https://www.text.com/docs/api/customer-chat/v3.6/properties/update-chat-properties.md) - [Update event properties](https://www.text.com/docs/api/customer-chat/v3.6/properties/update-event-properties.md) - [Update thread properties](https://www.text.com/docs/api/customer-chat/v3.6/properties/update-thread-properties.md) - [Chats](https://www.text.com/docs/api/customer-chat/v3.6/rtm/chats.md): Reference of Chats methods for the Customer Chat RTM API v3.6. - [Customers](https://www.text.com/docs/api/customer-chat/v3.6/rtm/customers.md): Reference of Customers methods for the Customer Chat RTM API v3.6. - [Data structures](https://www.text.com/docs/api/customer-chat/v3.6/rtm/data-structures.md): Reference of data structures available in the Customer Chat API v3.6. - [Events](https://www.text.com/docs/api/customer-chat/v3.6/rtm/events.md): Reference of Events methods for the Customer Chat RTM API v3.6. - [About the Customer Chat RTM API](https://www.text.com/docs/api/customer-chat/v3.6/rtm/index.md): Real-time messaging API for building customer-facing Text integrations over WebSocket. - [Other](https://www.text.com/docs/api/customer-chat/v3.6/rtm/other.md): Reference of other methods for the Customer Chat RTM API v3.6. - [Properties](https://www.text.com/docs/api/customer-chat/v3.6/rtm/properties.md): Reference of Properties methods for the Customer Chat RTM API v3.6. - [Pushes](https://www.text.com/docs/api/customer-chat/v3.6/rtm/pushes.md): Reference of push messages for the Customer Chat RTM API v3.6. - [Status](https://www.text.com/docs/api/customer-chat/v3.6/rtm/status.md): Reference of Status methods for the Customer Chat RTM API v3.6. - [List group statuses](https://www.text.com/docs/api/customer-chat/v3.6/status/list-group-statuses.md): One of the optional parameters needs to be included in the request. - [Create customer property definition](https://www.text.com/docs/api/customer-data-platform/customer-properties/create-customer-property-definition.md): Creates a new customer property schema entry for the organization. The property `id` is a UUID generated by the store. An organization can have at most 30 customer properties. Required scope: `customers:rw`. - [List customer property definitions](https://www.text.com/docs/api/customer-data-platform/customer-properties/list-customer-property-definitions.md): Returns all customer property schema entries for the organization, plus the schema-level `last_updated_at` timestamp and `last_updated_by` account ID of the most recent mutation. Required scope: `customers:ro`. - [Update customer property definition](https://www.text.com/docs/api/customer-data-platform/customer-properties/update-customer-property-definition.md): Updates the editable fields of an existing customer property. Only `name`, `description`, and `type_configuration` can be changed; `type` is immutable. At least one of `name`, `description`, or `type_configuration` must be provided. Required scope: `customers:rw`. - [Get customer](https://www.text.com/docs/api/customer-data-platform/customers/get-customer.md): Returns the customer data. - [Get customers count](https://www.text.com/docs/api/customer-data-platform/customers/get-customers-count.md): Available for Text App only. Returns a count of customers matching the specified search criteria. The request body follows the same structure as `list_customers`, but sorting and pagination parameters are ignored. - [Get merged customer](https://www.text.com/docs/api/customer-data-platform/customers/get-merged-customer.md): Returns the merged customer data. - [Get merged customer chat IDs](https://www.text.com/docs/api/customer-data-platform/customers/get-merged-customer-chat-ids.md): Returns the merged customer chat IDs. - [Get merged customer ticket IDs](https://www.text.com/docs/api/customer-data-platform/customers/get-merged-customer-ticket-ids.md): Returns the merged customer ticket IDs. - [List customers](https://www.text.com/docs/api/customer-data-platform/customers/list-customers.md): Available for Text App only. Searches and lists customers with filtering, sorting, and pagination. - [Default properties](https://www.text.com/docs/api/events-and-properties/default-properties.md): Default properties are created for each new Text license. You can use them in applications to extract important info about chats, threads, and events. - [Properties overview](https://www.text.com/docs/api/events-and-properties/properties-overview.md): Use properties to attach custom data to chats, events, users, and more. - [System activities](https://www.text.com/docs/api/events-and-properties/system-activities.md): Learn about system activities generated in the Text ecosystem. They are native system events displayed to users in various situations. - [Get account settings for an organization](https://www.text.com/docs/api/global-accounts/accountorganizationsettings/get-account-settings-for-an-organization.md): This HTTP endpoint allows you to retrieve a list of account organization settings. - [Update account settings for an organization](https://www.text.com/docs/api/global-accounts/accountorganizationsettings/update-account-settings-for-an-organization.md): This HTTP endpoint allows you to update various organization settings of an account. - [Approve an account invitation](https://www.text.com/docs/api/global-accounts/accounts/approve-an-account-invitation.md): Approve an account invitation. - [Create a new account](https://www.text.com/docs/api/global-accounts/accounts/create-a-new-account.md): Create an account for a given `organization_id`. This endpoint is idempotent. - [Create an account invitation](https://www.text.com/docs/api/global-accounts/accounts/create-an-account-invitation.md): Create an account invitation for the given `email`, `organization_id`, and `product`. After the successful creation, it sends an email to all users with the invitation approval scopes, informing them about the new account awaiting the approval. `organization_id` and `creator_id` are retrieved from t… - [Decline an account invitation](https://www.text.com/docs/api/global-accounts/accounts/decline-an-account-invitation.md): Decline and delete an account invitation. - [Delete an account](https://www.text.com/docs/api/global-accounts/accounts/delete-an-account.md): Deletes an account for a given `account_id`. The ID can be replaced with `me` to delete the account that performs the request. - [Get an account](https://www.text.com/docs/api/global-accounts/accounts/get-an-account.md): Get an account for a given `account_id`. The ID can be replaced with `me` to get the account that performs the request. To get an account along with its role, you need the `accounts.roles--all:ro` scope. - [Get an account invitations](https://www.text.com/docs/api/global-accounts/accounts/get-an-account-invitations.md): This method gets all invitations issued within an organization. If the `email` parameter is provided, it returns only the invitations sent for the account assigned with the `email` (within the requester's organization). - [List accounts](https://www.text.com/docs/api/global-accounts/accounts/list-accounts.md): Accounts are listed by using `organization_id` obtained from the access token. - [Set a password](https://www.text.com/docs/api/global-accounts/accounts/set-a-password.md): This method sets a new password. A successful call revokes all session tokens. It's possible to set a password for other accounts only when they belong to a single organization. - [Set account roles](https://www.text.com/docs/api/global-accounts/accounts/set-account-roles.md): Set or delete roles for a given `account_id`. Set overwrites a role group in case of conflicts. - [Update an account](https://www.text.com/docs/api/global-accounts/accounts/update-an-account.md): Update an account for a given `account_id`. The ID can be replaced with `me` to update the account that performs the request. To set a role for an account, you need the `accounts.roles--all:rw` scope. - [Create organization domain](https://www.text.com/docs/api/global-accounts/organizationdomains/create-organization-domain.md): This endpoint adds a new domain to the organization's email address domains whitelist. It's forbidden to add domains used for disposable email addresses or used by free email providers. Maximum number of domains added to an organization is 10. - [Delete organization domain](https://www.text.com/docs/api/global-accounts/organizationdomains/delete-organization-domain.md): Delete an organization domain by its ID. - [List organization domains](https://www.text.com/docs/api/global-accounts/organizationdomains/list-organization-domains.md): Lists all organization domains. The list is used for whitelisting email address domains, that are free to join to given organization. - [Disable login method](https://www.text.com/docs/api/global-accounts/organizationloginmethods/disable-login-method.md): Disables a login method for the organization. - [Enforce login method](https://www.text.com/docs/api/global-accounts/organizationloginmethods/enforce-login-method.md): Enforces a login method for the organization. - [Get login methods](https://www.text.com/docs/api/global-accounts/organizationloginmethods/get-login-methods.md): Returns the login methods for the organization. - [Create an organization](https://www.text.com/docs/api/global-accounts/organizations/create-an-organization.md): Creates an organization and an account. Calling this endpoint won't result in email notifications. Alternatively, you can use Bearer/Basic authorization instead of creating a new account for an organization; it will create a new organization for the account associated with the token. - [Get an organization](https://www.text.com/docs/api/global-accounts/organizations/get-an-organization.md): This function retrieves a single organization based on the provided organization ID. You can use `my` instead of an ID to get the organization linked with the access token used in the request. - [List organizations](https://www.text.com/docs/api/global-accounts/organizations/list-organizations.md): Lists all organizations that an account belongs to, based on authorization. This request doesn't need any specific scope. - [Update an organization](https://www.text.com/docs/api/global-accounts/organizations/update-an-organization.md): Updates an organization. You can use `my` instead of an ID to get the organization linked with the access token used in the request. - [Delete a role](https://www.text.com/docs/api/global-accounts/roles/delete-a-role.md): Delete a single role for a given `role_id`. Only the `custom` role can be deleted. All tokens related to a given role will be revoked. - [Get a role](https://www.text.com/docs/api/global-accounts/roles/get-a-role.md): Get a single role for a given `role_id`. The role is returned with the scopes assigned to it. - [List roles](https://www.text.com/docs/api/global-accounts/roles/list-roles.md): List the roles available for an organization. The result combines predefined and user-defined roles. - [Create SAML configuration](https://www.text.com/docs/api/global-accounts/saml/create-saml-configuration.md): Creates SAML configuration for the organization. To create a SAML configuration, the organization needs to have at least one product with an enterprise subscription. - [Delete SAML configuration](https://www.text.com/docs/api/global-accounts/saml/delete-saml-configuration.md): Removes SAML configuration for the organization. It will enable other authentication methods for the organization. - [Get configuration](https://www.text.com/docs/api/global-accounts/saml/get-configuration.md): Returns the SAML configuration for the organization. - [Modify SAML configuration](https://www.text.com/docs/api/global-accounts/saml/modify-saml-configuration.md): Modifies SAML configuration for the organization. When changing the active parameter, it will enable SAML configuration. This will cause other authentication (login/password, etc.) methods to be disabled for that organization. Activation of SAML configuration will be blocked if there is no product o… - [List sessions](https://www.text.com/docs/api/global-accounts/sessions/list-sessions.md): Returns all sessions for a given account ID. The account ID is obtained from an authorization grant. - [Remove a session](https://www.text.com/docs/api/global-accounts/sessions/remove-a-session.md): Removes a specific session for a given account ID. The account ID is obtained from an authorization grant. It's impossible to remove a session for other accounts. All access tokens related to the sessions will be revoked. - [Remove all sessions](https://www.text.com/docs/api/global-accounts/sessions/remove-all-sessions.md): Removes all sessions for a given account ID. The account ID is obtained from an authorization grant. It's impossible to remove a session for other accounts. All access tokens related to the sessions will be revoked. - [Introspect](https://www.text.com/docs/api/global-accounts/tokens/introspect.md): Returns detailed information about the provided OAuth access token. Useful for token validation and introspection. The access token can be provided via authorization or a query string. - [Revoke](https://www.text.com/docs/api/global-accounts/tokens/revoke.md): Access tokens that come in pairs with a refresh token are revoked in pairs. - [Token](https://www.text.com/docs/api/global-accounts/tokens/token.md): This endpoint is used by confidential and public clients to exchange an authorization code for an access token. Depending on the application type, the following parameters are required for `grant_type=code`: * Confidental (private) client – `client_secret` is required * Public client – matching `cod… - [Detect language](https://www.text.com/docs/api/language-detection/language-detection/detect-language.md): Detects languages used in text. The request size limit is 10MB. - [Create API token](https://www.text.com/docs/api/partner/account/create-api-token.md): Creates a new API token. - [Get API tokens](https://www.text.com/docs/api/partner/account/get-api-tokens.md): Returns the list of active API tokens. - [Get balance](https://www.text.com/docs/api/partner/account/get-balance.md): Returns balance information for the authenticated partner. - [Get billing](https://www.text.com/docs/api/partner/account/get-billing.md): Returns billing information for the authenticated partner. - [Get commission metric](https://www.text.com/docs/api/partner/account/get-commission-metric.md): Returns the commission metric for the given filters. - [Get commission report](https://www.text.com/docs/api/partner/account/get-commission-report.md): Returns commission reports for the given date range. - [Get coupons](https://www.text.com/docs/api/partner/account/get-coupons.md): Returns the list of active coupons. - [Get earnings](https://www.text.com/docs/api/partner/account/get-earnings.md): Returns earnings information including commission earned, balance, blocked and pending amounts. - [Get partners referred earnings report](https://www.text.com/docs/api/partner/account/get-partners-referred-earnings-report.md): Returns commission earned from referring partners. - [Get profile](https://www.text.com/docs/api/partner/account/get-profile.md): Returns profile information for the authenticated partner. - [Get stats](https://www.text.com/docs/api/partner/account/get-stats.md): Returns the number of licenses for each product and partnership model. - [Get withdrawals](https://www.text.com/docs/api/partner/account/get-withdrawals.md): Returns the list of withdrawals. - [Request withdrawal](https://www.text.com/docs/api/partner/account/request-withdrawal.md): Creates a withdrawal request. - [Revoke API token](https://www.text.com/docs/api/partner/account/revoke-api-token.md): Revokes an API token. - [Update billing](https://www.text.com/docs/api/partner/account/update-billing.md): Updates billing information for the authenticated partner. - [Update profile](https://www.text.com/docs/api/partner/account/update-profile.md): Updates profile information for the authenticated partner. - [Create campaign](https://www.text.com/docs/api/partner/affiliate-partner/create-campaign.md): Creates a new campaign. - [Disable campaign](https://www.text.com/docs/api/partner/affiliate-partner/disable-campaign.md): Disables a campaign. - [Get affiliate licenses](https://www.text.com/docs/api/partner/affiliate-partner/get-affiliate-licenses.md): Returns the list of affiliate licenses. - [Get affiliate links](https://www.text.com/docs/api/partner/affiliate-partner/get-affiliate-links.md): Returns affiliate links (long and short version) for default campaigns of each product. - [Get best performing campaigns clicks metrics](https://www.text.com/docs/api/partner/affiliate-partner/get-best-performing-campaigns-clicks-metrics.md): Returns summarized number of clicks generated from a given number of best performing campaigns. - [Get best performing campaigns clicks report](https://www.text.com/docs/api/partner/affiliate-partner/get-best-performing-campaigns-clicks-report.md): Returns clicks report for a given number of best performing campaigns. - [Get best performing campaigns conversions metrics](https://www.text.com/docs/api/partner/affiliate-partner/get-best-performing-campaigns-conversions-metrics.md): Returns summarized number of trials converted into paid licenses generated from a given number of best performing campaigns. - [Get best performing campaigns conversions report](https://www.text.com/docs/api/partner/affiliate-partner/get-best-performing-campaigns-conversions-report.md): Returns conversions report for a given number of best performing campaigns. - [Get best performing campaigns earnings metrics](https://www.text.com/docs/api/partner/affiliate-partner/get-best-performing-campaigns-earnings-metrics.md): Returns summarized earnings generated from a given number of best performing campaigns. - [Get best performing campaigns earnings report](https://www.text.com/docs/api/partner/affiliate-partner/get-best-performing-campaigns-earnings-report.md): Returns earnings report for a given number of best performing campaigns. - [Get best performing campaigns trials metrics](https://www.text.com/docs/api/partner/affiliate-partner/get-best-performing-campaigns-trials-metrics.md): Returns summarized number of trials generated from a given number of best performing campaigns. - [Get best performing campaigns trials report](https://www.text.com/docs/api/partner/affiliate-partner/get-best-performing-campaigns-trials-report.md): Returns trials report for a given number of best performing campaigns. - [Get campaign earnings metric](https://www.text.com/docs/api/partner/affiliate-partner/get-campaign-earnings-metric.md): Returns the affiliate campaign earnings metric. - [Get campaign earnings report](https://www.text.com/docs/api/partner/affiliate-partner/get-campaign-earnings-report.md): Returns the affiliate campaign earnings report. - [Get campaign summary](https://www.text.com/docs/api/partner/affiliate-partner/get-campaign-summary.md): Returns the affiliate campaign summary. - [Get campaigns](https://www.text.com/docs/api/partner/affiliate-partner/get-campaigns.md): Returns campaigns. - [Get clicks metrics](https://www.text.com/docs/api/partner/affiliate-partner/get-clicks-metrics.md): Returns clicks generated from affiliate campaigns. - [Get clicks report](https://www.text.com/docs/api/partner/affiliate-partner/get-clicks-report.md): Returns clicks report for affiliate activity over time (up to last 12 months). - [Get conversions metrics](https://www.text.com/docs/api/partner/affiliate-partner/get-conversions-metrics.md): Returns the number of trials converted into paid licenses generated from affiliate campaigns. - [Get conversions report](https://www.text.com/docs/api/partner/affiliate-partner/get-conversions-report.md): Returns conversions report for affiliate activity over time (up to last 12 months). - [Get earnings metrics](https://www.text.com/docs/api/partner/affiliate-partner/get-earnings-metrics.md): Returns earnings generated from affiliate campaigns. - [Get earnings report](https://www.text.com/docs/api/partner/affiliate-partner/get-earnings-report.md): Returns earnings report for affiliate activity over time (up to last 12 months). - [Get partners referred](https://www.text.com/docs/api/partner/affiliate-partner/get-partners-referred.md): Returns the list of referred partners. - [Get performance report](https://www.text.com/docs/api/partner/affiliate-partner/get-performance-report.md): Returns the affiliate performance report. - [Get referred partners commission metrics](https://www.text.com/docs/api/partner/affiliate-partner/get-referred-partners-commission-metrics.md): Returns commission generated from referred partners' activity. - [Get summary](https://www.text.com/docs/api/partner/affiliate-partner/get-summary.md): Returns the number of trial, paid, and expired affiliate licenses. - [Get trials metrics](https://www.text.com/docs/api/partner/affiliate-partner/get-trials-metrics.md): Returns the number of trials generated from affiliate campaigns. - [Get trials report](https://www.text.com/docs/api/partner/affiliate-partner/get-trials-report.md): Returns trials report for affiliate activity over time (up to last 12 months). - [Search campaigns](https://www.text.com/docs/api/partner/affiliate-partner/search-campaigns.md): Searches for campaigns. - [Create expert profile](https://www.text.com/docs/api/partner/partner-directory/create-expert-profile.md): Creates the Expert profile. - [Get comments](https://www.text.com/docs/api/partner/partner-directory/get-comments.md): Returns comments on the Expert profile. - [Get expert history](https://www.text.com/docs/api/partner/partner-directory/get-expert-history.md): Returns historical stats for the Expert profile views (up to last 12 months). - [Get expert profile](https://www.text.com/docs/api/partner/partner-directory/get-expert-profile.md): Returns the Expert profile details. - [Get expert stats](https://www.text.com/docs/api/partner/partner-directory/get-expert-stats.md): Returns stats (Experts Marketplace position, number of comments and messages) for the Expert profile. - [Update expert profile](https://www.text.com/docs/api/partner/partner-directory/update-expert-profile.md): Updates the Expert profile details. - [Upload logo](https://www.text.com/docs/api/partner/partner-directory/upload-logo.md): Uploads the Expert logo. The request body should contain a `.jpg` or `.png` image, min. 350x350px, max. 1000x1000px. - [Close subscription](https://www.text.com/docs/api/partner/solution-partner/close-subscription.md): Closes a subscription for a license. - [Create license](https://www.text.com/docs/api/partner/solution-partner/create-license.md): Creates a new license inside an organization for a client. - [Create organization](https://www.text.com/docs/api/partner/solution-partner/create-organization.md): Creates a new organization for a client. - [Create subscription](https://www.text.com/docs/api/partner/solution-partner/create-subscription.md): Creates a new subscription for a license. - [Get lead details](https://www.text.com/docs/api/partner/solution-partner/get-lead-details.md): Returns lead details. - [Get lead history](https://www.text.com/docs/api/partner/solution-partner/get-lead-history.md): Returns lead history. - [Get leads](https://www.text.com/docs/api/partner/solution-partner/get-leads.md): Returns partner leads. - [Get license details](https://www.text.com/docs/api/partner/solution-partner/get-license-details.md): Returns the license details. - [Get license invoice PDF](https://www.text.com/docs/api/partner/solution-partner/get-license-invoice-pdf.md): Returns a PDF invoice. - [Get license invoices](https://www.text.com/docs/api/partner/solution-partner/get-license-invoices.md): Returns invoices for a given license. - [Get license metrics](https://www.text.com/docs/api/partner/solution-partner/get-license-metrics.md): Returns the number of trials, paid licenses, and expired licenses from the Solution program. - [Get organization details](https://www.text.com/docs/api/partner/solution-partner/get-organization-details.md): Returns the organization details. - [Get organization licenses](https://www.text.com/docs/api/partner/solution-partner/get-organization-licenses.md): Returns the organization's licenses. - [Get Recurly token](https://www.text.com/docs/api/partner/solution-partner/get-recurly-token.md): Returns the token from Recurly. The token is required when creating a new subscription or updating an existing one with the new billing info. - [Get solution licenses](https://www.text.com/docs/api/partner/solution-partner/get-solution-licenses.md): Returns the list of licenses. - [Get solution licenses by status](https://www.text.com/docs/api/partner/solution-partner/get-solution-licenses-by-status.md): Returns the list of licenses by status. - [Get solution licenses CSV report](https://www.text.com/docs/api/partner/solution-partner/get-solution-licenses-csv-report.md): Returns a CSV report for licenses. - [Get solution licenses report](https://www.text.com/docs/api/partner/solution-partner/get-solution-licenses-report.md): Returns a report for licenses by license status. - [Get solution summary](https://www.text.com/docs/api/partner/solution-partner/get-solution-summary.md): Returns a summary from the Solution Program. - [Invite license operators](https://www.text.com/docs/api/partner/solution-partner/invite-license-operators.md): Invites operators to a license. - [Submit lead](https://www.text.com/docs/api/partner/solution-partner/submit-lead.md): Submits a lead. - [Transfer license](https://www.text.com/docs/api/partner/solution-partner/transfer-license.md): Transfers a license to the client. - [Update license billing](https://www.text.com/docs/api/partner/solution-partner/update-license-billing.md): Updates the subscription billing information for a license. - [Update license details](https://www.text.com/docs/api/partner/solution-partner/update-license-details.md): Updates the license details. - [Update subscription](https://www.text.com/docs/api/partner/solution-partner/update-subscription.md): Updates a subscription for a license. - [Availability](https://www.text.com/docs/api/reports/v3.6/agents/availability.md): Returns for how long an agent, group, or the whole account was available for chatting during a specified period of time. Depending on the `distribution` parameter, the response contains a different time resolution. - [Performance](https://www.text.com/docs/api/reports/v3.6/agents/performance.md): Returns the total number of agent chats, the number of good and bad ratings they received, and how well they performed in the early stages of a chat. The report also shows the time an agent spent chatting, accepting and not accepting chats, as well as the total time they were logged in. - [Duration](https://www.text.com/docs/api/reports/v3.6/chats/duration.md): Returns the average chatting duration of agents within a license. - [Engagement](https://www.text.com/docs/api/reports/v3.6/chats/engagement.md): Returns the distribution of chats based on engagement during the specified period. - [First response time](https://www.text.com/docs/api/reports/v3.6/chats/first-response-time.md): Returns the average agents' first response time within a licence. - [Forms](https://www.text.com/docs/api/reports/v3.6/chats/forms.md): Returns the number of submitted chat forms along with the count of specific answers. The `distribution` parameter has no effect on the response of this method. - [Greetings conversion](https://www.text.com/docs/api/reports/v3.6/chats/greetings-conversion.md): Returns the number of greetings sent to the customers and how many of those resulted in a chat or a goal. Greetings are also known as targeted messages. - [Group chats count](https://www.text.com/docs/api/reports/v3.6/chats/group-chats-count.md): Returns the total number of chats handled by each group during the specified period. - [Ranking](https://www.text.com/docs/api/reports/v3.6/chats/ranking.md): Returns the ratio of good to bad ratings for each operator. The `distribution` parameter has no effect on the response of this method. - [Ratings](https://www.text.com/docs/api/reports/v3.6/chats/ratings.md): Returns the number of rated chats along with their ratings during a specified period of time. - [Response time](https://www.text.com/docs/api/reports/v3.6/chats/response-time.md): Returns the average agents' response time within a licence. - [Tags](https://www.text.com/docs/api/reports/v3.6/chats/tags.md): Returns the distribution of tags for chats. - [Total chats](https://www.text.com/docs/api/reports/v3.6/chats/total-chats.md): Returns how many chats occurred during the specified period. - [Queued visitors](https://www.text.com/docs/api/reports/v3.6/customers/queued-visitors.md): Returns the number of customers who waited in the queue during the specified period. - [Queued visitors left](https://www.text.com/docs/api/reports/v3.6/customers/queued-visitors-left.md): Returns queue records for visitors who left the queue during the specified period. - [Unique visitors](https://www.text.com/docs/api/reports/v3.6/customers/unique-visitors.md): Returns the total number of page views and unique visitors during the specified period. - [Chat usage](https://www.text.com/docs/api/reports/v3.6/tags/chat-usage.md): Returns the total number of chats marked with each tag listed in the report. - [Batch update agents](https://www.text.com/docs/api/ticketing/agents/batch-update-agents.md) - [Create agent](https://www.text.com/docs/api/ticketing/agents/create-agent.md) - [Delete agent](https://www.text.com/docs/api/ticketing/agents/delete-agent.md) - [Get agent](https://www.text.com/docs/api/ticketing/agents/get-agent.md) - [List agents](https://www.text.com/docs/api/ticketing/agents/list-agents.md) - [Update agent](https://www.text.com/docs/api/ticketing/agents/update-agent.md) - [Returns audit log events](https://www.text.com/docs/api/ticketing/audit-log/returns-audit-log-events.md) - [Create canned response](https://www.text.com/docs/api/ticketing/canned-responses/create-canned-response.md) - [Delete canned response](https://www.text.com/docs/api/ticketing/canned-responses/delete-canned-response.md) - [Get canned response](https://www.text.com/docs/api/ticketing/canned-responses/get-canned-response.md) - [List canned responses](https://www.text.com/docs/api/ticketing/canned-responses/list-canned-responses.md) - [Update canned response](https://www.text.com/docs/api/ticketing/canned-responses/update-canned-response.md) - [Create custom field](https://www.text.com/docs/api/ticketing/custom-fields/create-custom-field.md) - [Delete custom field](https://www.text.com/docs/api/ticketing/custom-fields/delete-custom-field.md) - [Get custom field](https://www.text.com/docs/api/ticketing/custom-fields/get-custom-field.md) - [List custom fields](https://www.text.com/docs/api/ticketing/custom-fields/list-custom-fields.md) - [Update custom field](https://www.text.com/docs/api/ticketing/custom-fields/update-custom-field.md) - [Check domain availability](https://www.text.com/docs/api/ticketing/email-domains/check-domain-availability.md) - [Create email domain](https://www.text.com/docs/api/ticketing/email-domains/create-email-domain.md) - [Delete email domain](https://www.text.com/docs/api/ticketing/email-domains/delete-email-domain.md) - [Email domains list](https://www.text.com/docs/api/ticketing/email-domains/email-domains-list.md) - [Get email domain](https://www.text.com/docs/api/ticketing/email-domains/get-email-domain.md) - [Verify email domain](https://www.text.com/docs/api/ticketing/email-domains/verify-email-domain.md) - [Create imported ticket](https://www.text.com/docs/api/ticketing/imported-tickets/create-imported-ticket.md): By default this endpoint creates a **ticket without attachments**. If you want to create a ticket containing attachments: 1. Create new import transaction by issuing `POST` request to `/v1/importedTickets/transactions` endpoint 2. Upload attachments by issuing `POST` request(s) to `/v1/importedTicke… - [Create imported ticket transaction](https://www.text.com/docs/api/ticketing/imported-tickets/create-imported-ticket-transaction.md): Creates new import transaction. Transaction ID is required for ticket creation with attachments. - [Upload attachments for imported ticket](https://www.text.com/docs/api/ticketing/imported-tickets/upload-attachments-for-imported-ticket.md): Uploads attachments for imported ticket. Attachments are required for ticket creation with attachments. - [Create license](https://www.text.com/docs/api/ticketing/licenses/create-license.md): Creates new license object. Only required during first app login after account in Text has been created. - [Get license](https://www.text.com/docs/api/ticketing/licenses/get-license.md): Returns license data by `licenseID`. - [List licenses](https://www.text.com/docs/api/ticketing/licenses/list-licenses.md): Returns list of licenses. Normally it contains only one element. - [Send forwarding instructions](https://www.text.com/docs/api/ticketing/licenses/send-forwarding-instructions.md): Sends email with instructions on setting up email forwarding. - [Update license](https://www.text.com/docs/api/ticketing/licenses/update-license.md): Allows changing license settings: - default team - default template - company name - [Create macro](https://www.text.com/docs/api/ticketing/macros/create-macro.md) - [Delete macro](https://www.text.com/docs/api/ticketing/macros/delete-macro.md) - [Get macro](https://www.text.com/docs/api/ticketing/macros/get-macro.md) - [Macros list](https://www.text.com/docs/api/ticketing/macros/macros-list.md) - [Update macro](https://www.text.com/docs/api/ticketing/macros/update-macro.md) - [Create mailbox](https://www.text.com/docs/api/ticketing/mailboxes-inboxes/create-mailbox.md) - [Delete mailbox](https://www.text.com/docs/api/ticketing/mailboxes-inboxes/delete-mailbox.md) - [Get mailbox](https://www.text.com/docs/api/ticketing/mailboxes-inboxes/get-mailbox.md) - [List mailboxes](https://www.text.com/docs/api/ticketing/mailboxes-inboxes/list-mailboxes.md) - [Update mailbox](https://www.text.com/docs/api/ticketing/mailboxes-inboxes/update-mailbox.md) - [Create reply address](https://www.text.com/docs/api/ticketing/reply-addresses/create-reply-address.md) - [Delete reply address](https://www.text.com/docs/api/ticketing/reply-addresses/delete-reply-address.md) - [Get reply address](https://www.text.com/docs/api/ticketing/reply-addresses/get-reply-address.md) - [List reply addresses](https://www.text.com/docs/api/ticketing/reply-addresses/list-reply-addresses.md) - [Agent rating](https://www.text.com/docs/api/ticketing/reports/agent-rating.md) - [Create custom report](https://www.text.com/docs/api/ticketing/reports/create-custom-report.md) - [Failed outgoing emails](https://www.text.com/docs/api/ticketing/reports/failed-outgoing-emails.md) - [New tickets](https://www.text.com/docs/api/ticketing/reports/new-tickets.md) - [New tickets (24h distribution)](https://www.text.com/docs/api/ticketing/reports/new-tickets-24h-distribution.md) - [Rating per agent](https://www.text.com/docs/api/ticketing/reports/rating-per-agent.md) - [Rating per team](https://www.text.com/docs/api/ticketing/reports/rating-per-team.md) - [Resolution time](https://www.text.com/docs/api/ticketing/reports/resolution-time.md) - [Resolution time (24h distribution)](https://www.text.com/docs/api/ticketing/reports/resolution-time-24h-distribution.md) - [Resolution time per agent](https://www.text.com/docs/api/ticketing/reports/resolution-time-per-agent.md) - [Resolution time per team](https://www.text.com/docs/api/ticketing/reports/resolution-time-per-team.md) - [Response time](https://www.text.com/docs/api/ticketing/reports/response-time.md) - [Response time (24h distribution)](https://www.text.com/docs/api/ticketing/reports/response-time-24h-distribution.md) - [Response time per agent](https://www.text.com/docs/api/ticketing/reports/response-time-per-agent.md) - [Response time per team](https://www.text.com/docs/api/ticketing/reports/response-time-per-team.md) - [Ticket rating](https://www.text.com/docs/api/ticketing/reports/ticket-rating.md) - [Ticket rating (24h distribution)](https://www.text.com/docs/api/ticketing/reports/ticket-rating-24h-distribution.md) - [Ticket sources](https://www.text.com/docs/api/ticketing/reports/ticket-sources.md) - [Ticket sources (24h distribution)](https://www.text.com/docs/api/ticketing/reports/ticket-sources-24h-distribution.md) - [Ticket status](https://www.text.com/docs/api/ticketing/reports/ticket-status.md) - [Ticket status (24h distribution)](https://www.text.com/docs/api/ticketing/reports/ticket-status-24h-distribution.md) - [Tickets status duration](https://www.text.com/docs/api/ticketing/reports/tickets-status-duration.md) - [Tickets status duration per agent](https://www.text.com/docs/api/ticketing/reports/tickets-status-duration-per-agent.md) - [Tickets status duration per team](https://www.text.com/docs/api/ticketing/reports/tickets-status-duration-per-team.md) - [Tickets status duration total](https://www.text.com/docs/api/ticketing/reports/tickets-status-duration-total.md) - [Tickets status per agent](https://www.text.com/docs/api/ticketing/reports/tickets-status-per-agent.md) - [Tickets status per team](https://www.text.com/docs/api/ticketing/reports/tickets-status-per-team.md) - [Create rule](https://www.text.com/docs/api/ticketing/rules/create-rule.md) - [Delete rule](https://www.text.com/docs/api/ticketing/rules/delete-rule.md) - [Get rule](https://www.text.com/docs/api/ticketing/rules/get-rule.md) - [List rules](https://www.text.com/docs/api/ticketing/rules/list-rules.md) - [Update rule](https://www.text.com/docs/api/ticketing/rules/update-rule.md) - [Block an email](https://www.text.com/docs/api/ticketing/spam-management/block-an-email.md) - [Get blocked email](https://www.text.com/docs/api/ticketing/spam-management/get-blocked-email.md) - [Get trusted email](https://www.text.com/docs/api/ticketing/spam-management/get-trusted-email.md) - [List blocked emails](https://www.text.com/docs/api/ticketing/spam-management/list-blocked-emails.md) - [List trusted emails](https://www.text.com/docs/api/ticketing/spam-management/list-trusted-emails.md) - [Remove blocked email](https://www.text.com/docs/api/ticketing/spam-management/remove-blocked-email.md) - [Remove trusted email](https://www.text.com/docs/api/ticketing/spam-management/remove-trusted-email.md) - [Trust an email](https://www.text.com/docs/api/ticketing/spam-management/trust-an-email.md) - [Create tag](https://www.text.com/docs/api/ticketing/tags/create-tag.md) - [Delete tag](https://www.text.com/docs/api/ticketing/tags/delete-tag.md) - [Get tag](https://www.text.com/docs/api/ticketing/tags/get-tag.md) - [List tags](https://www.text.com/docs/api/ticketing/tags/list-tags.md) - [Update tag](https://www.text.com/docs/api/ticketing/tags/update-tag.md) - [Create team](https://www.text.com/docs/api/ticketing/teams/create-team.md) - [Delete team](https://www.text.com/docs/api/ticketing/teams/delete-team.md) - [Get team](https://www.text.com/docs/api/ticketing/teams/get-team.md) - [List teams](https://www.text.com/docs/api/ticketing/teams/list-teams.md) - [Update team](https://www.text.com/docs/api/ticketing/teams/update-team.md) - [Update teams](https://www.text.com/docs/api/ticketing/teams/update-teams.md) - [Create template](https://www.text.com/docs/api/ticketing/templates/create-template.md) - [Delete template](https://www.text.com/docs/api/ticketing/templates/delete-template.md) - [Generate template preview](https://www.text.com/docs/api/ticketing/templates/generate-template-preview.md) - [Get template](https://www.text.com/docs/api/ticketing/templates/get-template.md) - [List templates](https://www.text.com/docs/api/ticketing/templates/list-templates.md) - [Send test message](https://www.text.com/docs/api/ticketing/templates/send-test-message.md) - [Update template](https://www.text.com/docs/api/ticketing/templates/update-template.md) - [Add followers](https://www.text.com/docs/api/ticketing/tickets/add-followers.md) - [Add tag](https://www.text.com/docs/api/ticketing/tickets/add-tag.md) - [Create ticket](https://www.text.com/docs/api/ticketing/tickets/create-ticket.md) - [Delete ticket](https://www.text.com/docs/api/ticketing/tickets/delete-ticket.md) - [Delete tickets attachment](https://www.text.com/docs/api/ticketing/tickets/delete-tickets-attachment.md) - [Get original message content](https://www.text.com/docs/api/ticketing/tickets/get-original-message-content.md) - [Get ticket](https://www.text.com/docs/api/ticketing/tickets/get-ticket.md) - [List tickets](https://www.text.com/docs/api/ticketing/tickets/list-tickets.md) - [Merge ticket](https://www.text.com/docs/api/ticketing/tickets/merge-ticket.md) - [Move ticket to silo](https://www.text.com/docs/api/ticketing/tickets/move-ticket-to-silo.md) - [Remove follower](https://www.text.com/docs/api/ticketing/tickets/remove-follower.md) - [Remove tag](https://www.text.com/docs/api/ticketing/tickets/remove-tag.md) - [Send rating request](https://www.text.com/docs/api/ticketing/tickets/send-rating-request.md) - [Unmerge ticket](https://www.text.com/docs/api/ticketing/tickets/unmerge-ticket.md) - [Update ticket](https://www.text.com/docs/api/ticketing/tickets/update-ticket.md) - [Create transaction](https://www.text.com/docs/api/ticketing/transactions/create-transaction.md) - [Delete attachment](https://www.text.com/docs/api/ticketing/transactions/delete-attachment.md) - [Get transaction](https://www.text.com/docs/api/ticketing/transactions/get-transaction.md) - [Upload attachment](https://www.text.com/docs/api/ticketing/transactions/upload-attachment.md) - [Create view](https://www.text.com/docs/api/ticketing/views/create-view.md) - [Delete view](https://www.text.com/docs/api/ticketing/views/delete-view.md) - [Get view](https://www.text.com/docs/api/ticketing/views/get-view.md) - [Update view](https://www.text.com/docs/api/ticketing/views/update-view.md) - [Views list](https://www.text.com/docs/api/ticketing/views/views-list.md) - [Create webhook](https://www.text.com/docs/api/ticketing/webhooks/create-webhook.md) - [Delete webhook](https://www.text.com/docs/api/ticketing/webhooks/delete-webhook.md) - [Get webhook](https://www.text.com/docs/api/ticketing/webhooks/get-webhook.md) - [Update webhook](https://www.text.com/docs/api/ticketing/webhooks/update-webhook.md) - [Webhooks list](https://www.text.com/docs/api/ticketing/webhooks/webhooks-list.md) - [Custom Identity Provider](https://www.text.com/docs/authentication/custom-identity-provider.md): Learn how to use custom identity to build cross-platform chats for your applications. - [Customer tokens](https://www.text.com/docs/authentication/customer-tokens.md): Learn the importance of using a different access token for the Customer Chat API. Explore the various customer authorization flows. - [Authentication errors](https://www.text.com/docs/authentication/errors.md): OAuth error codes returned by the Text authorization server, their meanings, and possible causes. - [OAuth authorization](https://www.text.com/docs/authentication/oauth-authorization.md): Learn how to use OAuth with Text APIs. Choose the right authorization flow and implement Implicit Grant, Authorization Code Grant, or Sign in with Text. - [Overview](https://www.text.com/docs/authentication/overview.md): Understand how authentication and authorization work across Text APIs, what token types exist, and how scopes control what each one can do. - [Personal access tokens](https://www.text.com/docs/authentication/personal-access-tokens.md): Use personal access tokens to authenticate requests to Text APIs. Learn how to create tokens, configure scopes, and send authorized API requests. - [Scopes](https://www.text.com/docs/authentication/scopes.md): Learn how to use OAuth 2.1 to access Text data securely. Check general rules of scopes. - [API pricing](https://www.text.com/docs/getting-started/api-pricing.md): Learn how API usage is billed and how to track your request volume. - [Quickstart](https://www.text.com/docs/getting-started/index.md): Get up and running with the Text API — make your first call, understand how auth works, and find the right API for what you're building. - [Model Context Protocol (MCP)](https://www.text.com/docs/getting-started/mcp.md): Learn how to connect AI assistants to Text using the Model Context Protocol. - [API versioning](https://www.text.com/docs/key-concepts/api-versioning.md): How Text API versions work, what each stage means, and what to do at each one. - [Chats](https://www.text.com/docs/key-concepts/chats.md): Text conversations are structured as chats, threads, and events. Understanding this model is the foundation for any Text API integration. - [Users and accounts](https://www.text.com/docs/key-concepts/users-and-accounts.md): Who participates in Text conversations, how they're grouped for routing, and how identity works across accounts and organizations. - [Accounts SDK](https://www.text.com/docs/sdk/accounts-sdk.md): The Accounts SDK is a JavaScript tool for implementing Sign in with Text authorization in your app. - [Disconnection reasons](https://www.text.com/docs/sdk/customer-sdk/disconnection-reasons.md) - [Errors](https://www.text.com/docs/sdk/customer-sdk/errors.md) - [Events](https://www.text.com/docs/sdk/customer-sdk/events.md) - [Methods](https://www.text.com/docs/sdk/customer-sdk/methods.md) - [How to start](https://www.text.com/docs/sdk/customer-sdk/overview/how-to-start.md) - [Introduction](https://www.text.com/docs/sdk/customer-sdk/overview/introduction.md) - [Key concepts](https://www.text.com/docs/sdk/customer-sdk/overview/key-concepts.md) - [Recipes](https://www.text.com/docs/sdk/customer-sdk/recipes.md) - [Disconnection reasons](https://www.text.com/docs/sdk/customer-sdk/v4.0/disconnection-reasons.md) - [Errors](https://www.text.com/docs/sdk/customer-sdk/v4.0/errors.md) - [Events](https://www.text.com/docs/sdk/customer-sdk/v4.0/events.md) - [Methods](https://www.text.com/docs/sdk/customer-sdk/v4.0/methods.md) - [How to start](https://www.text.com/docs/sdk/customer-sdk/v4.0/overview/how-to-start.md) - [Recipes](https://www.text.com/docs/sdk/customer-sdk/v4.0/recipes.md) ## OpenAPI Specs - [openapi](https://www.text.com/docs/api/customer-data-platform/openapi.json)