LiveChat

App · 29 actions

Work with your LiveChat inbox: list, read and search chats, send messages and private notes, start, close and transfer chats, tag threads, and manage agents' availability, groups, tags and canned responses.

Actions

ActionWhat it does
Close chatClose a chat's open thread.
Create canned responseSave a reply agents can insert while chatting.
Create groupCreate a group from some agents, all with the same routing priority.
Create tagCreate a tag agents can put on threads, optionally limited to some groups.
Delete canned responseDelete a canned response.
Delete groupDelete a group.
Delete tagDelete a tag.
Get agentGet one agent with their role, groups, job title and chat limit.
Get chatGet one chat with its users and one thread (the latest unless you name one), including the thread's events.
Get groupGet one group with its agents' priorities and routing status.
Get thread transcriptGet a thread as plain text: who said what and when, including files and forms.
List agent availabilitySee which agents (and bots) are accepting chats, optionally within some groups.
List agentsList the account's agents with their role, groups, job title, chat limit and whether they are suspended.
List canned responsesList canned responses (saved replies) in your groups.
List chatsList chats with their latest message, filtered by whether they are active and by group.
List groupsList the account's groups (teams that chats are routed to) with their agents and whether they are online.
List tagsList the account's tags with the groups each belongs to.
List threadsList a chat's threads (its separate conversations) with their events, optionally within a time range.
Remove tag from threadTake a tag off a thread.
Reopen chatReopen a deactivated chat in a new thread, optionally with a message from you.
Search chat archiveSearch past conversations by text, time, group, agent, tag or customer email.
Send messageWrite a message in an active chat as the token's agent, to everyone in it or as a private note for agents.
Set my availabilitySet whether the agent the token belongs to is accepting chats.
Start chatStart a chat with you in it, optionally with a first message.
Tag threadAdd a tag to a thread.
Transfer chatHand an active chat to a group or to one agent.
Update canned responseChange a canned response.
Update groupRename a group or replace its agents.
Update tagReplace the groups a tag belongs to.

Close chat

Close a chat's open thread. Nobody can write to it afterwards until it is reopened.

Inputs

Chat IDchat_idtextRequired
The chat's id, from 'List chats', 'Start chat' or an earlier step.
Close even if you are not in the chatignore_requester_presencetrue/false
Turn on to close a chat that your agent has not joined, such as one that was transferred away.Default: false.

Outputs

chat_idtext
The chat's id
deactivatedtrue/false
Always true once closed
Example output
{
  "chat_id": "PJ0MRSHTDG",
  "deactivated": true
}

Create canned response

Save a reply agents can insert while chatting.

Inputs

TexttexttextRequired
The reply agents insert.
Groupgroup_idtextRequired
The group whose agents can use it.
Shortcutstagslist
Words agents type after # to find this response. Type a word and press Enter.
Privateis_privatetrue/false
Turn on so only you see this canned response.

Outputs

canned_response_idnumber
The new canned response's id
Example output
{
  "canned_response_id": 12345
}

Create group

Create a group from some agents, all with the same routing priority. Changes take up to two minutes to apply.

Inputs

NamenametextRequired
The group's name, up to 180 characters.
Agentsagent_idslistRequired
The agents in the group. Pick them from the list.
Routing priorityprioritytext
How chats are given to these agents. Defaults to normal.One of: normal (Normal (default)), first (First: gets chats before the others), last (Last: gets chats only when nobody else is free), supervisor (Supervisor: never gets chats assigned).

Outputs

group_idnumber
The new group's id
nametext
The group's name
Example output
{
  "group_id": 19,
  "name": "Sales"
}

Create tag

Create a tag agents can put on threads, optionally limited to some groups. Matching an existing name ignores letter case.

Inputs

NamenametextRequired
The tag's name.
Groupsgroup_idslist
The groups that can use the tag. Leave empty for none yet.

Outputs

createdtrue/false
Always true once created
group_idslist
The groups it belongs to
nametext
The tag's name
Example output
{
  "created": true,
  "group_ids": [
    0
  ],
  "name": "docs_feedback"
}

Delete canned response

Delete a canned response.

Inputs

Canned response IDcanned_response_idtextRequired
The canned response's id, from 'List canned responses'.

Outputs

canned_response_idnumber
The canned response deleted
deletedtrue/false
Always true once deleted
Example output
{
  "canned_response_id": 12345,
  "deleted": true
}

Delete group

Delete a group. The agents stay in the account.

Inputs

Groupgroup_idtextRequired
The group. Pick one, or give its id from an earlier step.

Outputs

deletedtrue/false
Always true once deleted
group_idnumber
The group deleted
Example output
{
  "deleted": true,
  "group_id": 19
}

Delete tag

Delete a tag. The name is case sensitive.

Inputs

TagnametextRequired
The tag. Pick one, or give its name from an earlier step. It is case sensitive.

Outputs

deletedtrue/false
Always true once deleted
nametext
The tag deleted
Example output
{
  "deleted": true,
  "name": "docs_feedback"
}

Get agent

Get one agent with their role, groups, job title and chat limit.

Inputs

Agentagent_idtextRequired
The agent. Pick one, or give their email address.

Outputs

agentobject
The agent
Example output
{
  "agent": {
    "account_id": "d24fa41e-bc16-41b8-a15b-9ca45ff7e0cf",
    "avatar": null,
    "avatar_path": null,
    "groups": [
      {
        "id": 0,
        "priority": "normal"
      }
    ],
    "id": "smith@example.com",
    "job_title": "Support Hero",
    "last_logout": null,
    "login_status": "accepting chats",
    "max_chats_count": 6,
    "name": "Agent Smith",
    "role": "owner",
    "suspended": false
  }
}

Get chat

Get one chat with its users and one thread (the latest unless you name one), including the thread's events.

Inputs

Chat IDchat_idtextRequired
The chat's id, from 'List chats', 'Start chat' or an earlier step.
Thread IDthread_idtext
The thread to read. Defaults to the latest.

Outputs

chatobject
The chat
Example output
{
  "chat": {
    "access": {
      "group_ids": [
        0
      ]
    },
    "id": "PJ0MRSHTDG",
    "is_followed": false,
    "properties": null,
    "thread": {
      "access": {
        "group_ids": [
          0
        ]
      },
      "active": true,
      "created_at": "2026-10-15T09:00:00.000000Z",
      "events": [
        {
          "author_id": "smith@example.com",
          "created_at": "2026-10-15T09:00:00.000000Z",
          "id": "Q20N9CKRX2_1",
          "text": "Hello",
          "type": "message",
          "visibility": "agents"
        }
      ],
      "id": "K600PKZON8",
      "next_thread_id": null,
      "previous_thread_id": null,
      "properties": null,
      "summary": null,
      "user_ids": [
        "smith@example.com"
      ]
    },
    "users": [
      {
        "avatar": null,
        "email": "smith@example.com",
        "id": "smith@example.com",
        "name": "Agent Smith",
        "present": true,
        "type": "agent",
        "visibility": "all"
      }
    ]
  }
}

Get group

Get one group with its agents' priorities and routing status.

Inputs

Groupgroup_idtextRequired
The group. Pick one, or give its id from an earlier step.

Outputs

groupobject
The group
Example output
{
  "group": {
    "agent_priorities": {
      "smith@example.com": "normal"
    },
    "id": 19,
    "language_code": "en",
    "name": "Sales",
    "routing_status": "offline"
  }
}

Get thread transcript

Get a thread as plain text: who said what and when, including files and forms.

Inputs

Chat IDchat_idtextRequired
The chat's id, from 'List chats', 'Start chat' or an earlier step.
Thread IDthread_idtextRequired
The thread's id, from 'Get chat', 'List threads' or 'Start chat'.

Outputs

chat_idtext
The chat's id
thread_idtext
The thread's id
transcripttext
The conversation as plain text
Example output
{
  "chat_id": "PJ0MRSHTDG",
  "thread_id": "K600PKZON8",
  "transcript": "Conversation transcript:\n----------\nAgent Smith (Thu, 10/15/2026, 09:00:00 am UTC)\nHello"
}

List agent availability

See which agents (and bots) are accepting chats, optionally within some groups.

Inputs

Groupsgroup_idslist
Only agents in these groups. Leave empty for everyone.

Outputs

countnumber
How many came back on this page
statuseslist
Each agent's status
Example output
{
  "count": 1,
  "statuses": [
    {
      "agent_id": "smith@example.com",
      "status": "accepting_chats"
    }
  ]
}

List agents

List the account's agents with their role, groups, job title, chat limit and whether they are suspended.

Inputs

Groupsgroup_idslist
Only agents in these groups. Leave empty for everyone.
Agentsstatetext
Active agents, suspended ones, or both.One of: all (Active and suspended (default)), active (Active only), suspended (Suspended only).

Outputs

agentslist
The agents
countnumber
How many came back on this page
Example output
{
  "agents": [
    {
      "account_id": "d24fa41e-bc16-41b8-a15b-9ca45ff7e0cf",
      "avatar": null,
      "avatar_path": null,
      "groups": [
        {
          "id": 0,
          "priority": "normal"
        }
      ],
      "id": "smith@example.com",
      "job_title": "Support Hero",
      "last_logout": null,
      "login_status": "accepting chats",
      "max_chats_count": 6,
      "name": "Agent Smith",
      "role": "owner",
      "suspended": false
    }
  ],
  "count": 1
}

List canned responses

List canned responses (saved replies) in your groups. Gets one page; to see more, run it again with the next page it gives.

Inputs

Groupsgroup_idslist
Only responses in these groups. Leave empty for yours.
Include private onesinclude_privatetrue/false
Turn on to include your private canned responses.Default: false.
Page sizelimitnumber
How many to return, 1 to 1000. LiveChat's default is 100.From 1 to 1000.
Page IDpage_idtext
The 'next_page_id' from an earlier page, to get the page after it. Leave the other fields empty: LiveChat repeats the first search.

Outputs

canned_responseslist
The canned responses
countnumber
How many came back on this page
found_canned_responsesnumber
How many match in all
next_page_idtext
Pass as 'Page ID' for the next page; empty on the last one
Example output
{
  "canned_responses": [
    {
      "author_id": "smith@example.com",
      "created_at": "2026-10-15T09:00:00.000000Z",
      "group_id": 0,
      "id": 12345,
      "is_private": false,
      "tags": [
        "greeting"
      ],
      "text": "Thank you for contacting us! How can I help you today?",
      "updated_at": "2026-10-15T09:00:00.000000Z"
    }
  ],
  "count": 1,
  "found_canned_responses": 1,
  "next_page_id": ""
}

List chats

List chats with their latest message, filtered by whether they are active and by group. Gets one page; to see more, run it again with the next page it gives.

Inputs

Chatsstatustext
Only active chats, only inactive ones, or both.One of: all (Active and inactive (default)), active (Active only), inactive (Inactive only).
Groupsgroup_idslist
Only chats in these groups. Leave empty for all groups.
Ordersort_ordertext
Which to list first. Defaults to newest first.One of: desc (Newest first (default)), asc (Oldest first).
Page sizelimitnumber
How many to return, 1 to 100.From 1 to 100.
Page IDpage_idtext
The 'next_page_id' from an earlier page, to get the page after it. Leave the other fields empty: LiveChat repeats the first search.

Outputs

chatslist
The chats
countnumber
How many came back on this page
found_chatsnumber
An estimate of how many chats match in all
next_page_idtext
Pass as 'Page ID' for the next page; empty on the last one
previous_page_idtext
The page id of the page before this one; empty on the first
Example output
{
  "chats": [
    {
      "access": {
        "group_ids": [
          0
        ]
      },
      "id": "PJ0MRSHTDG",
      "is_followed": false,
      "last_event_per_type": {
        "message": {
          "event": {
            "author_id": "smith@example.com",
            "created_at": "2026-10-15T09:00:00.000000Z",
            "id": "Q20N9CKRX2_1",
            "text": "Hello",
            "type": "message",
            "visibility": "agents"
          },
          "thread_created_at": "2026-10-15T09:00:00.000000Z",
          "thread_id": "K600PKZON8"
        }
      },
      "last_thread_summary": {
        "access": {
          "group_ids": [
            0
          ]
        },
        "active": true,
        "created_at": "2026-10-15T09:00:00.000000Z",
        "id": "K600PKZON8",
        "user_ids": [
          "smith@example.com"
        ]
      },
      "properties": null,
      "users": [
        {
          "avatar": null,
          "email": "smith@example.com",
          "id": "smith@example.com",
          "name": "Agent Smith",
          "present": true,
          "type": "agent",
          "visibility": "all"
        }
      ]
    }
  ],
  "count": 1,
  "found_chats": 1,
  "next_page_id": "",
  "previous_page_id": ""
}

List groups

List the account's groups (teams that chats are routed to) with their agents and whether they are online.

Inputs

None.

Outputs

countnumber
How many came back on this page
groupslist
The groups
Example output
{
  "count": 1,
  "groups": [
    {
      "agent_priorities": {
        "smith@example.com": "normal"
      },
      "id": 19,
      "language_code": "en",
      "name": "Sales",
      "routing_status": "offline"
    }
  ]
}

List tags

List the account's tags with the groups each belongs to.

Inputs

Groupsgroup_idslist
Only tags in these groups. Leave empty for all.

Outputs

countnumber
How many came back on this page
tagslist
The tags
Example output
{
  "count": 1,
  "tags": [
    {
      "author_id": "smith@example.com",
      "created_at": "2026-10-15T09:00:00.000000Z",
      "group_ids": [
        0
      ],
      "name": "docs_feedback"
    }
  ]
}

List threads

List a chat's threads (its separate conversations) with their events, optionally within a time range.

Inputs

Chat IDchat_idtextRequired
The chat's id, from 'List chats', 'Start chat' or an earlier step.
Started afterfrom_timedate and time
Only threads from this time on.
Started beforeto_timedate and time
Only threads up to this time.
Ordersort_ordertext
Which to list first. Defaults to newest first.One of: desc (Newest first (default)), asc (Oldest first).
Page sizelimitnumber
How many to return, 1 to 100.From 1 to 100.
Page IDpage_idtext
The 'next_page_id' from an earlier page, to get the page after it. Leave the other fields empty: LiveChat repeats the first search.

Outputs

countnumber
How many came back on this page
found_threadsnumber
An estimate of how many threads match in all
next_page_idtext
Pass as 'Page ID' for the next page; empty on the last one
previous_page_idtext
The page id of the page before this one; empty on the first
threadslist
The threads
Example output
{
  "count": 1,
  "found_threads": 1,
  "next_page_id": "",
  "previous_page_id": "",
  "threads": [
    {
      "access": {
        "group_ids": [
          0
        ]
      },
      "active": true,
      "created_at": "2026-10-15T09:00:00.000000Z",
      "events": [
        {
          "author_id": "smith@example.com",
          "created_at": "2026-10-15T09:00:00.000000Z",
          "id": "Q20N9CKRX2_1",
          "text": "Hello",
          "type": "message",
          "visibility": "agents"
        }
      ],
      "id": "K600PKZON8",
      "next_thread_id": null,
      "previous_thread_id": null,
      "properties": null,
      "summary": null,
      "user_ids": [
        "smith@example.com"
      ]
    }
  ]
}

Remove tag from thread

Take a tag off a thread.

Inputs

Chat IDchat_idtextRequired
The chat's id, from 'List chats', 'Start chat' or an earlier step.
Thread IDthread_idtextRequired
The thread's id, from 'Get chat', 'List threads' or 'Start chat'.
TagtagtextRequired
The tag. Pick one, or give its name from an earlier step.

Outputs

chat_idtext
The chat's id
tagtext
The tag removed
thread_idtext
The thread's id
Example output
{
  "chat_id": "PJ0MRSHTDG",
  "tag": "docs_feedback",
  "thread_id": "K600PKZON8"
}

Reopen chat

Reopen a deactivated chat in a new thread, optionally with a message from you.

Inputs

Chat IDchat_idtextRequired
The chat's id, from 'List chats', 'Start chat' or an earlier step.
First messagemessagetext
A message to open the new thread with, written by you.
Who sees itvisibilitytext
Everyone in the chat, or agents only as a private note.One of: all (Everyone in the chat, customer included (default)), agents (Agents only (a private note)).

Outputs

chat_idtext
The chat's id
event_idslist
Ids of the messages written when it started
thread_idtext
The thread's id
Example output
{
  "chat_id": "PJ0MRSHTDG",
  "event_ids": [],
  "thread_id": "Z8AGR5OUW"
}

Search chat archive

Search past conversations by text, time, group, agent, tag or customer email. Each result is one thread of a chat.

Inputs

Search textquerytext
Only threads whose messages contain this text.
Fromfrom_timedate and time
Only threads from this time on.
Untilto_timedate and time
Only threads up to this time.
Groupsgroup_idslist
Only threads in these groups.
Agentsagent_idslist
Only threads these agents took part in.
Tagstagslist
Only threads with one of these tags.
Customer emailcustomer_emailtext
Only chats with the customer who has this email address.
Ordersort_ordertext
Which to list first. Defaults to newest first.One of: desc (Newest first (default)), asc (Oldest first).
Page sizelimitnumber
How many to return, 1 to 100.From 1 to 100.
Page IDpage_idtext
The 'next_page_id' from an earlier page, to get the page after it. Leave the other fields empty: LiveChat repeats the first search.

Outputs

chatslist
The matching chats, one thread each
countnumber
How many came back on this page
found_chatsnumber
An estimate of how many chats match in all
next_page_idtext
Pass as 'Page ID' for the next page; empty on the last one
previous_page_idtext
The page id of the page before this one; empty on the first
Example output
{
  "chats": [
    {
      "access": {
        "group_ids": [
          0
        ]
      },
      "id": "PJ0MRSHTDG",
      "is_followed": false,
      "properties": null,
      "thread": {
        "access": {
          "group_ids": [
            0
          ]
        },
        "active": true,
        "created_at": "2026-10-15T09:00:00.000000Z",
        "events": [
          {
            "author_id": "smith@example.com",
            "created_at": "2026-10-15T09:00:00.000000Z",
            "id": "Q20N9CKRX2_1",
            "text": "Hello",
            "type": "message",
            "visibility": "agents"
          }
        ],
        "id": "K600PKZON8",
        "next_thread_id": null,
        "previous_thread_id": null,
        "properties": null,
        "summary": null,
        "user_ids": [
          "smith@example.com"
        ]
      },
      "users": [
        {
          "avatar": null,
          "email": "smith@example.com",
          "id": "smith@example.com",
          "name": "Agent Smith",
          "present": true,
          "type": "agent",
          "visibility": "all"
        }
      ]
    }
  ],
  "count": 1,
  "found_chats": 1,
  "next_page_id": "",
  "previous_page_id": ""
}

Send message

Write a message in an active chat as the token's agent, to everyone in it or as a private note for agents. The agent must be in the chat.

Inputs

Chat IDchat_idtextRequired
The chat's id, from 'List chats', 'Start chat' or an earlier step.
MessagetexttextRequired
What to write.
Who sees itvisibilitytext
Everyone in the chat, or agents only as a private note.One of: all (Everyone in the chat, customer included (default)), agents (Agents only (a private note)).

Outputs

chat_idtext
The chat's id
event_idtext
The new message's event id
Example output
{
  "chat_id": "PJ0MRSHTDG",
  "event_id": "Q20N9CKRX2_2"
}

Set my availability

Set whether the agent the token belongs to is accepting chats.

Inputs

StatusstatustextRequired
Accepting chats, or not.One of: accepting_chats (Accepting chats), not_accepting_chats (Not accepting chats).

Outputs

statustext
The status now in effect
Example output
{
  "status": "not_accepting_chats"
}

Start chat

Start a chat with you in it, optionally with a first message. Customers are not added; use a private note to leave a record only agents see.

Inputs

Groupgroup_idtext
The group the chat belongs to. Defaults to your own groups.
First messagemessagetext
The chat's first message, written by you.
Who sees itvisibilitytext
Everyone in the chat, or agents only as a private note.One of: all (Everyone in the chat, customer included (default)), agents (Agents only (a private note)).
Continuous chatcontinuoustrue/false
Turn on to start the chat as a continuous one, which needs no group online.Default: false.

Outputs

chat_idtext
The chat's id
event_idslist
Ids of the messages written when it started
thread_idtext
The thread's id
Example output
{
  "chat_id": "PJ0MRSHTDG",
  "event_ids": [
    "Q20N9CKRX2_1"
  ],
  "thread_id": "K600PKZON8"
}

Tag thread

Add a tag to a thread. The tag must exist and share a group with the chat.

Inputs

Chat IDchat_idtextRequired
The chat's id, from 'List chats', 'Start chat' or an earlier step.
Thread IDthread_idtextRequired
The thread's id, from 'Get chat', 'List threads' or 'Start chat'.
TagtagtextRequired
The tag. Pick one, or give its name from an earlier step.

Outputs

chat_idtext
The chat's id
tagtext
The tag added
thread_idtext
The thread's id
Example output
{
  "chat_id": "PJ0MRSHTDG",
  "tag": "docs_feedback",
  "thread_id": "K600PKZON8"
}

Transfer chat

Hand an active chat to a group or to one agent. Give a group or an agent, not both.

Inputs

Chat IDchat_idtextRequired
The chat's id, from 'List chats', 'Start chat' or an earlier step.
Transfer to groupgroup_idtext
The group to hand the chat to. Give this or an agent, not both.
Transfer to agentagent_idtext
The agent to hand the chat to. Give this or a group, not both.
Queue if nobody is freeignore_agents_availabilitytrue/false
Turn on to put the chat in the queue when no agent is available, instead of failing.Default: false.
Transfer even if you are not in the chatignore_requester_presencetrue/false
Turn on to transfer a chat that your agent has not joined.Default: false.

Outputs

chat_idtext
The chat's id
target_idtext
The group or agent it went to
target_typetext
group or agent
transferredtrue/false
Always true once transferred
Example output
{
  "chat_id": "PJ0MRSHTDG",
  "target_id": "19",
  "target_type": "group",
  "transferred": true
}

Update canned response

Change a canned response. Only the fields given change.

Inputs

Canned response IDcanned_response_idtextRequired
The canned response's id, from 'List canned responses'.
Texttexttext
The new reply text. Leave empty to keep it.
Groupgroup_idtext
Move it to this group. Leave empty to keep it.
Shortcutstagslist
Words agents type after # to find this response. Type a word and press Enter.
Privateis_privatetrue/false
Turn on so only you see this canned response.

Outputs

canned_response_idnumber
The canned response's id
updatedtrue/false
Always true once updated
Example output
{
  "canned_response_id": 12345,
  "updated": true
}

Update group

Rename a group or replace its agents. Only the fields given change; giving agents replaces the whole list.

Inputs

Groupgroup_idtextRequired
The group. Pick one, or give its id from an earlier step.
New namenametext
A new name for the group. Leave empty to keep it.
Agentsagent_idslist
Replaces the group's agents with these. Leave empty to keep them.
Routing priorityprioritytext
How chats are given to these agents. Defaults to normal.One of: normal (Normal (default)), first (First: gets chats before the others), last (Last: gets chats only when nobody else is free), supervisor (Supervisor: never gets chats assigned).

Outputs

group_idnumber
The group's id
updatedtrue/false
Always true once updated
Example output
{
  "group_id": 19,
  "updated": true
}

Update tag

Replace the groups a tag belongs to.

Inputs

TagnametextRequired
The tag. Pick one, or give its name from an earlier step. It is case sensitive.
Groupsgroup_idslistRequired
The groups that can use the tag from now on.

Outputs

group_idslist
The groups it belongs to now
nametext
The tag's name
updatedtrue/false
Always true once updated
Example output
{
  "group_ids": [
    0
  ],
  "name": "docs_feedback",
  "updated": true
}

On this page