Skip to content

ME-1234 remove follow_customer and unfollow_customer methods from agent-api #1630

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
oliwiapolec merged 2 commits into from
Jan 21, 2026
Merged

ME-1234 remove follow_customer and unfollow_customer methods from agent-api #1630

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
65578a2
remove follow_customer and unfollow_customer methods from agent-api
Slimak-Text Jan 5, 2026
e13e590
remove customer_unfollowed push
Slimak-Text Jan 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
94 changes: 1 addition & 93 deletions src/pages/messaging/agent-chat-api/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ curl -X POST \
| **Events** | [`send_event_preview`](#send-event-preview) [`send_event`](#send-event) [`upload_file`](#upload-file) [`send_rich_message_postback`](#send-rich-message-postback) |
| **Properties** | [`update_chat_properties`](#update-chat-properties) [`delete_chat_properties`](#delete-chat-properties) [`update_thread_properties`](#update-thread-properties) [`delete_thread_properties`](#delete-thread-properties) [`update_event_properties`](#update-event-properties) [`delete_event_properties`](#delete-event-properties) |
| **Thread tags** | [`tag_thread`](#tag-thread) [`untag_thread`](#untag-thread) |
| **Customers** | [`get_customer`](#get-customer) [`update_customer`](#update-customer) [`ban_customer`](#ban-customer) [`follow_customer`](#follow-customer) [`unfollow_customer`](#unfollow-customer) |
| **Customers** | [`get_customer`](#get-customer) [`update_customer`](#update-customer) [`ban_customer`](#ban-customer) |
| **Status** | [`set_routing_status`](#set-routing-status) [`list_routing_statuses`](#list-routing-statuses) |
| **Other** | [`mark_events_as_seen`](#mark-events-as-seen) [`send_thinking_indicator`](#send-thinking-indicator) [`send_typing_indicator`](#send-typing-indicator) [`multicast`](#multicast) [`list_agents_for_transfer`](#list-agents-for-transfer) [`request_thread_summary`](#request-thread-summary) |

Expand Down Expand Up @@ -2119,98 +2119,6 @@ https://api.livechatinc.com/v3.6/agent/action/ban_customer \
</Code>
</Section>

<Section>
<Text>

### Follow Customer

Marks a customer as followed. As a result, the requester (an agent) will receive the info about all the changes related to that customer via pushes. Once the customer leaves the website or is [unfollowed](#unfollow-customer), the agent will no longer receive that information.

Following a customer causes the agent to receive customer-related pushes as long as the followed customer is available. The followed customer may be transferred to a group the agent doesn't have access to, which makes the customer unavailable to the agent. At that moment, the agent stops receiving pushes related to that customer. When the customer is transferred back and becomes available again, the pushes resume.

Agents don't need to follow the customers they're chatting with in order to receive related pushes. Agents will be receiving pushes related to those customers as long as the chats last.

#### Specifics

| | |
| ---------------------- | ---------------------------------------------------------------------------------- |
| **Method URL** | `https://api.livechatinc.com/v3.6/agent/action/follow_customer` |
| **Required scopes** | `customers:ro` |
| **RTM API equivalent** | [`follow_customer`](/messaging/agent-chat-api/v3.6/rtm-reference/#follow-customer) |
| **Webhook** | - |

#### Request

| Parameter | Required | Data type | |
| --------- | -------- | --------- | --- |
| `id` | Yes | `string` | |

#### Response

No response payload (`200 OK`).

</Text>
<Code>
<CodeSample path={'REQUEST'}>

```shell
curl -X POST \
https://api.livechatinc.com/v3.6/agent/action/follow_customer \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"id": "b7eff798-f8df-4364-8059-649c35c9ed0c"
}'
```

</CodeSample>
</Code>
</Section>

<Section>
<Text>

### Unfollow Customer

Removes the agent from the list of customer's followers. Calling this method on a customer the agent's chatting with will result in success, however, the agent will still receive pushes about the customer's data updates. The unfollowing will take effect once the chat ends.

#### Specifics

| | |
| ---------------------- | -------------------------------------------------------------------------------------- |
| **Method URL** | `https://api.livechatinc.com/v3.6/agent/action/unfollow_customer` |
| **Required scopes** | - |
| **RTM API equivalent** | [`unfollow_customer`](/messaging/agent-chat-api/v3.6/rtm-reference/#unfollow-customer) |
| **Webhook** | - |

#### Request

| Parameter | Required | Data type | |
| --------- | -------- | --------- | --- |
| `id` | Yes | `string` | |

#### Response

No response payload (`200 OK`).

</Text>
<Code>
<CodeSample path={'REQUEST'}>

```shell
curl -X POST \
https://api.livechatinc.com/v3.6/agent/action/unfollow_customer \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"id": "b7eff798-f8df-4364-8059-649c35c9ed0c"
}'
```

</CodeSample>
</Code>
</Section>

## Status

<Section>
Expand Down
119 changes: 1 addition & 118 deletions src/pages/messaging/agent-chat-api/rtm-reference/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ When connecting to the Agent Chat RTM API, clients have to send over the require
| **Events** | [`send_event_preview`](#send-event-preview) [`send_event`](#send-event) [`send_rich_message_postback`](#send-rich-message-postback) |
| **Properties** | [`update_chat_properties`](#update-chat-properties) [`delete_chat_properties`](#delete-chat-properties) [`update_thread_properties`](#update-thread-properties) [`delete_thread_properties`](#delete-thread-properties) [`update_event_properties`](#update-event-properties) [`delete_event_properties`](#delete-event-properties) |
| **Thread tags** | [`tag_thread`](#tag-thread) [`untag_thread`](#untag-thread) |
| **Customers** | [`get_customer`](#get-customer) [`update_customer`](#update-customer) [`ban_customer`](#ban-customer) [`follow_customer`](#follow-customer) [`unfollow_customer`](#unfollow-customer) [`subscribe_customers`](#subscribe_customers) [`unsubscribe_customers`](#unsubscribe_customers) |
| **Customers** | [`get_customer`](#get-customer) [`update_customer`](#update-customer) [`ban_customer`](#ban-customer) [`subscribe_customers`](#subscribe_customers) [`unsubscribe_customers`](#unsubscribe_customers) |
| **Status** | [`login`](#login) [`set_routing_status`](#set-routing-status) [`set_away_status`](#set-away-status) [`logout`](#logout) [`list_routing_statuses`](#list-routing-statuses) [`update_session`](#update-session) |
| **Other** | [`mark_events_as_seen`](#mark-events-as-seen) [`send_thinking_indicator`](#send-thinking-indicator) [`send_typing_indicator`](#send-typing-indicator) [`multicast`](#multicast) [`list_agents_for_transfer`](#list-agents-for-transfer) [`request_thread_summary`](#request-thread-summary) |

Expand Down Expand Up @@ -2332,123 +2332,6 @@ Bans the customer for a specific period of time. It immediately disconnects all
<Section>
<Text>

### Follow Customer

Marks a customer as followed. As a result, the requester (an agent) will receive the info about all the changes related to that customer via pushes. Once the customer leaves the website or is [unfollowed](#unfollow-customer), the agent will no longer receive that information.

Following a customer causes the agent to receive customer-related pushes as long as the followed customer is available. The followed customer may be transferred to a group the agent doesn't have access to, which makes the customer unavailable to the agent. At that moment, the agent stops receiving pushes related to that customer. When the customer is transferred back and becomes available again, the pushes resume.

Agents don't need to follow the customers they're chatting with in order to receive related pushes. Agents will be receiving pushes related to those customers as long as the chats last.

#### Specifics

| | |
| ---------------------- | ----------------------------------------------------------------------------------------- |
| **Action** | `follow_customer` |
| **Required scopes** | `customers:ro` |
| **Web API equivalent** | [`follow_customer`](/messaging/agent-chat-api/v3.6/#follow-customer) |
| **Push message** | [`incoming_customer`](/messaging/agent-chat-api/v3.6/rtm-pushes/#incoming_customer)**\*** |

**\*)**
It won't be sent when the requester already follows the customer or is chatting with that customer.

#### Request

| Parameter | Required | Data type | Notes |
| --------- | -------- | --------- | ----- |
| `id` | Yes | `string` | |

</Text>
<Code>
<CodeSample path={'REQUEST'}>

```json
{
"action": "follow_customer",
"payload": {
"id": "b7eff798-f8df-4364-8059-649c35c9ed0c"
}
}
```

</CodeSample>

<CodeResponse>

```json
{
"request_id": "<request_id>", // optional
"action": "follow_customer",
"type": "response",
"success": true,
"payload": {
// no response payload
}
}
```

</CodeResponse>
</Code>
</Section>

<Section>
<Text>

### Unfollow Customer

Removes the agent from the list of customer's followers. Calling this method on a customer the agent's chatting with will result in success, however, the agent will still receive pushes about the customer's data updates. The unfollowing will take effect once the chat ends.

#### Specifics

| | |
| ---------------------- | --------------------------------------------------------------------------------------- |
| **Action** | `unfollow_customer` |
| **Required scopes** | - |
| **Web API equivalent** | [`unfollow_customer`](/messaging/agent-chat-api/v3.6/#unfollow-customer) |
| **Push message** | [`customer_unfollowed`](/messaging/agent-chat-api/v3.6/rtm-pushes/#customer_unfollowed) |

#### Request

| Parameter | Required | Data type | Notes |
| --------- | -------- | --------- | ----- |
| `id` | Yes | `string` | |

</Text>
<Code>
<CodeSample path={'REQUEST'}>

```json
{
"action": "unfollow_customer",
"payload": {
"id": "b7eff798-f8df-4364-8059-649c35c9ed0c"
}
}
```

</CodeSample>

<CodeResponse>

```json
{
"request_id": "<request_id>", // optional
"action": "unfollow_customer",
"type": "response",
"success": true,
"payload": {
// no response payload
}
}
```

</CodeResponse>
</Code>
</Section>

<Section>
<Text>

### Subscribe Customers

Creates a subscription for tracking customers based on the group they belong to. The response will contain customers currently matching the criteria. After a successful subscription, the agent will receive pushes about tracked customers on this RTM connection.
Expand Down
94 changes: 1 addition & 93 deletions src/pages/messaging/agent-chat-api/v3.4/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ curl -X POST \
| **Events** | [`send_event`](#send-event) [`upload_file`](#upload-file) [`send_rich_message_postback`](#send-rich-message-postback) |
| **Properties** | [`update_chat_properties`](#update-chat-properties) [`delete_chat_properties`](#delete-chat-properties) [`update_thread_properties`](#update-thread-properties) [`delete_thread_properties`](#delete-thread-properties) [`update_event_properties`](#update-event-properties) [`delete_event_properties`](#delete-event-properties) |
| **Thread tags** | [`tag_thread`](#tag-thread) [`untag_thread`](#untag-thread) |
| **Customers** | [`get_customer`](#get-customer) [`list_customers`](#list-customers) [`create_customer`](#create-customer) [`update_customer`](#update-customer) [`ban_customer`](#ban-customer) [`follow_customer`](#follow-customer) [`unfollow_customer`](#unfollow-customer) |
| **Customers** | [`get_customer`](#get-customer) [`list_customers`](#list-customers) [`create_customer`](#create-customer) [`update_customer`](#update-customer) [`ban_customer`](#ban-customer) |
| **Status** | [`set_routing_status`](#set-routing-status) [`list_routing_statuses`](#list-routing-statuses) |
| **Other** | [`mark_events_as_seen`](#mark-events-as-seen) [`send_typing_indicator`](#send-typing-indicator) [`multicast`](#multicast) [`list_agents_for_transfer`](#list-agents-for-transfer) |

Expand Down Expand Up @@ -2201,98 +2201,6 @@ https://api.livechatinc.com/v3.4/agent/action/ban_customer \
</Code>
</Section>

<Section>
<Text>

### Follow Customer

Marks a customer as followed. As a result, the requester (an agent) will receive the info about all the changes related to that customer via pushes. Once the customer leaves the website or is [unfollowed](#unfollow-customer), the agent will no longer receive that information.

Following a customer causes the agent to receive customer-related pushes as long as the followed customer is available. The followed customer may be transferred to a group the agent doesn't have access to, which makes the customer unavailable to the agent. At that moment, the agent stops receiving pushes related to that customer. When the customer is transferred back and becomes available again, the pushes resume.

Agents don't need to follow the customers they're chatting with in order to receive related pushes. Agents will be receiving pushes related to those customers as long as the chats last.

#### Specifics

| | |
| ---------------------- | ---------------------------------------------------------------------------------- |
| **Method URL** | `https://api.livechatinc.com/v3.4/agent/action/follow_customer` |
| **Required scopes** | `customers:ro` |
| **RTM API equivalent** | [`follow_customer`](/messaging/agent-chat-api/v3.4/rtm-reference/#follow-customer) |
| **Webhook** | - |

#### Request

| Parameter | Required | Data type | |
| --------- | -------- | --------- | --- |
| `id` | Yes | `string` | |

#### Response

No response payload (`200 OK`).

</Text>
<Code>
<CodeSample path={'REQUEST'}>

```shell
curl -X POST \
https://api.livechatinc.com/v3.4/agent/action/follow_customer \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"id": "b7eff798-f8df-4364-8059-649c35c9ed0c"
}'
```

</CodeSample>
</Code>
</Section>

<Section>
<Text>

### Unfollow Customer

Removes the agent from the list of customer's followers. Calling this method on a customer the agent's chatting with will result in success, however, the agent will still receive pushes about the customer's data updates. The unfollowing will take effect once the chat ends.

#### Specifics

| | |
| ---------------------- | -------------------------------------------------------------------------------------- |
| **Method URL** | `https://api.livechatinc.com/v3.4/agent/action/unfollow_customer` |
| **Required scopes** | - |
| **RTM API equivalent** | [`unfollow_customer`](/messaging/agent-chat-api/v3.4/rtm-reference/#unfollow-customer) |
| **Webhook** | - |

#### Request

| Parameter | Required | Data type | |
| --------- | -------- | --------- | --- |
| `id` | Yes | `string` | |

#### Response

No response payload (`200 OK`).

</Text>
<Code>
<CodeSample path={'REQUEST'}>

```shell
curl -X POST \
https://api.livechatinc.com/v3.4/agent/action/unfollow_customer \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"id": "b7eff798-f8df-4364-8059-649c35c9ed0c"
}'
```

</CodeSample>
</Code>
</Section>

## Status

<Section>
Expand Down
Loading