Using the Configuration API - Text Documentation

The Configuration API controls resources and rules shared across a Text organization. It covers agent and bot accounts, groups and access rules, greetings, properties, tags, and webhook registrations.

Before you start

For access requirements and version support, see:

Authorization
Scopes
API versioning

Propagation delay

Changes made through the Configuration API can take up to 2 minutes to take effect.

Configuration resources

Resource	Description
Agents	Use these methods to manage agent profiles: create or update agents, assign them to groups, and delete them.
Auto access	Auto access rules assign groups to a thread based on the customer’s geolocation and page URL. Text checks the rules when the customer logs in or changes pages. It applies the matching groups when the customer starts a chat and the thread is created.
Bots	Bots let integrations communicate in chats through the API in the same way as agents. Use these methods to manage bot templates and bot instances, issue bot tokens, and reset bot secrets.
Customer bans	Use these methods to list active bans for a customer or lift a ban.
Greetings	Greetings are messages shown to customers when campaign conditions are met. Use these methods to create greetings and manage their content, display conditions, and target groups.
Groups	Groups organize agents and bots into teams. They separate chat routing and provide shared configuration such as language, working hours, and department.
Properties	Properties are key-value fields grouped into namespaces. Each namespace belongs to the client that registered it and can be private or public. Use these methods to define property schemas and manage values stored on an organization or group.
Tags	Use the Tags resource to manage the labels available to agents for categorizing chat threads and filtering chats in archives and reports.
Webhooks	Webhooks send event notifications to a registered URL when specific events occur. Use these methods to register, list, and remove webhooks, or to control their state for an organization.
Other	This group contains organization operations that do not belong to another resource. You can inspect communication channels and product limits, retrieve the source parameters passed when the Text product was activated, reactivate a bounced email address, and update company details.

If you need to	Use
Work with conversations, including creating bans, applying tags, or updating chat properties	Agent Chat API
Check supported webhook actions and payloads	Webhooks reference
Store or query persistent customer profile data	Customer Data Platform API

For a broader comparison, see Management APIs.

Batch requests

Batch methods run the same operation on multiple resources in one request. Items are processed concurrently, so execution order is not guaranteed. The responses array follows the order of the input, and a failed item does not affect the other items.

A batch request requires the same scopes as the corresponding non-batch method. You cannot mix methods in one batch request.

Send a POST request to the batch method URL with a requests array. Each item uses the request payload of the corresponding non-batch method.

Methods that support batch requests

Agents

Method	Batch URL
Create agent	`https://api.livechatinc.com/v3.6/configuration/action/batch_create_agents`
Update agent	`https://api.livechatinc.com/v3.6/configuration/action/batch_update_agents`
Delete agent	`https://api.livechatinc.com/v3.6/configuration/action/batch_delete_agents`
Suspend agent	`https://api.livechatinc.com/v3.6/configuration/action/batch_suspend_agents`
Unsuspend agent	`https://api.livechatinc.com/v3.6/configuration/action/batch_unsuspend_agents`
Approve agent	`https://api.livechatinc.com/v3.6/configuration/action/batch_approve_agents`

Bots

Method	Batch URL
Create bot	`https://api.livechatinc.com/v3.6/configuration/action/batch_create_bots`
Update bot	`https://api.livechatinc.com/v3.6/configuration/action/batch_update_bots`
Delete bot	`https://api.livechatinc.com/v3.6/configuration/action/batch_delete_bots`

Example: delete multiple agents

Request

curl -X POST \
  https://api.livechatinc.com/v3.6/configuration/action/batch_delete_agents \
  -H 'Authorization: Basic <your_personal_access_token>' \
  -H 'Content-Type: application/json' \
  -d '{
        "requests": [
          { "id": "smith@example.com" },
          { "id": "brown@example.com" },
          {}
        ]
      }'

Response

{
  "responses": [
    {},
    {},
    {
      "error": {
        "type": "validation",
        "message": "`id` is required"
      }
    }
  ]
}

​Before you start

​Propagation delay

​Configuration resources

​Related APIs

​Batch requests

​Example: delete multiple agents

Before you start

Propagation delay

Configuration resources

Related APIs

Batch requests

Example: delete multiple agents