Skip to content

Commit 21920a1

Browse files
wfabjanczukwfabjanczuk
authored
feat: agent-api: remove method create_customer v3.6 (#1579)
1 parent 201567c commit 21920a1

File tree

3 files changed

+3
-127
lines changed

3 files changed

+3
-127
lines changed

‎src/pages/messaging/agent-chat-api/changelog/index.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ The developer preview version provides a preview of the upcoming changes to the
3838

3939
### Customers
4040

41-
- The **List Customers** method was removed.
41+
- The **Create Customer** and **List Customers** methods were removed.
4242
- The **Subscribe Customers** ([RTM](/messaging/agent-chat-api/v3.6/rtm-reference/#subscribe_customers)) and **Unsubscribe Customers** ([RTM](/messaging/agent-chat-api/v3.6/rtm-reference/#unsubscribe_customers)) methods along with a [**subscribed_customers_totals_updated**](/messaging/agent-chat-api/v3.6/rtm-pushes/#subscribed_customers_totals_updated) push were added.
4343
- The name of the `last_visit` field was changed to `visit` in the [**Customer**](/messaging/agent-chat-api/v3.6/data-structures#customer) data structure.
4444
- The [**Customer**](/messaging/agent-chat-api/v3.6/data-structures#customer) data structure now contains information about HelpDesk tickets (when available).

‎src/pages/messaging/agent-chat-api/v3.6/index.mdx‎

Lines changed: 1 addition & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ curl -X POST \
110110
| **Events** | [`send_event`](#send-event) [`upload_file`](#upload-file) [`send_rich_message_postback`](#send-rich-message-postback) |
111111
| **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) |
112112
| **Thread tags** | [`tag_thread`](#tag-thread) [`untag_thread`](#untag-thread) |
113-
| **Customers** | [`get_customer`](#get-customer) [`create_customer`](#create-customer) [`update_customer`](#update-customer) [`ban_customer`](#ban-customer) [`follow_customer`](#follow-customer) [`unfollow_customer`](#unfollow-customer) |
113+
| **Customers** | [`get_customer`](#get-customer) [`update_customer`](#update-customer) [`ban_customer`](#ban-customer) [`follow_customer`](#follow-customer) [`unfollow_customer`](#unfollow-customer) |
114114
| **Status** | [`set_routing_status`](#set-routing-status) [`list_routing_statuses`](#list-routing-statuses) |
115115
| **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) |
116116

@@ -1919,65 +1919,6 @@ https://api.livechatinc.com/v3.6/agent/action/get_customer \
19191919
<Section>
19201920
<Text>
19211921

1922-
### Create Customer
1923-
1924-
Creates a new [Customer](/messaging/agent-chat-api/v3.6/data-structures/#customer) user type.
1925-
1926-
#### Specifics
1927-
1928-
| | |
1929-
| ---------------------- | ---------------------------------------------------------------------------------- |
1930-
| **Method URL** | `https://api.livechatinc.com/v3.6/agent/action/create_customer` |
1931-
| **Required scopes** | `customers:rw` |
1932-
| **RTM API equivalent** | [`create_customer`](/messaging/agent-chat-api/v3.6/rtm-reference/#create-customer) |
1933-
| **Webhook** | [`incoming_customer`](/management/webhook/v3.6/#incoming_customer) |
1934-
1935-
#### Request
1936-
1937-
| Parameter | Required | Data type | Notes |
1938-
| ---------------- | -------- | ---------- | ---------------------------------------------------------------------------------- |
1939-
| `name` | No | `string` | |
1940-
| `email` | No | `string` | |
1941-
| `avatar` | No | `string` | URL of the Customer's avatar |
1942-
| `session_fields` | No | `[]object` | An array of custom object-enclosed `key:value` pairs. Respects the order of items. |
1943-
1944-
</Text>
1945-
<Code>
1946-
<CodeSample path={'REQUEST'}>
1947-
1948-
```shell
1949-
curl -X POST \
1950-
https://api.livechatinc.com/v3.6/agent/action/create_customer \
1951-
-H 'Authorization: Bearer <your_access_token>' \
1952-
-H 'Content-Type: application/json' \
1953-
-d '{
1954-
"name": "Thomas Anderson",
1955-
"email": "[email protected]",
1956-
"avatar": "https://example.com/avatars/1.png",
1957-
"session_fields": [{
1958-
"custom_key": "custom_value"
1959-
}, {
1960-
"another_custom_key": "another_custom_value"
1961-
}]
1962-
}'
1963-
```
1964-
1965-
</CodeSample>
1966-
<CodeResponse>
1967-
1968-
```json
1969-
{
1970-
"customer_id": "b7eff798-f8df-4364-8059-649c35c9ed0c"
1971-
}
1972-
```
1973-
1974-
</CodeResponse>
1975-
</Code>
1976-
</Section>
1977-
1978-
<Section>
1979-
<Text>
1980-
19811922
### Update Customer
19821923

19831924
Updates Customer's properties.

‎src/pages/messaging/agent-chat-api/v3.6/rtm-reference/index.mdx‎

Lines changed: 1 addition & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ When connecting to the Agent Chat RTM API, clients have to send over the require
116116
| **Events** | [`send_event`](#send-event) [`send_rich_message_postback`](#send-rich-message-postback) |
117117
| **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) |
118118
| **Thread tags** | [`tag_thread`](#tag-thread) [`untag_thread`](#untag-thread) |
119-
| **Customers** | [`get_customer`](#get-customer) [`create_customer`](#create-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) |
119+
| **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) |
120120
| **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) |
121121
| **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) |
122122

@@ -2106,71 +2106,6 @@ Returns the info about the Customer with a given `id`.
21062106
<Section>
21072107
<Text>
21082108

2109-
### Create Customer
2110-
2111-
Creates a new [Customer](/messaging/agent-chat-api/v3.6/data-structures/#customer) user type.
2112-
2113-
#### Specifics
2114-
2115-
| | |
2116-
| ---------------------- | ----------------------------------------------------------------------------------- |
2117-
| **Action** | `create_customer` |
2118-
| **Required scopes** | `customers:rw` |
2119-
| **Web API equivalent** | [`create_customer`](/messaging/agent-chat-api/v3.6/#create-customer) |
2120-
| **Push message** | [`incoming_customer`](/messaging/agent-chat-api/v3.6/rtm-pushes/#incoming_customer) |
2121-
2122-
#### Request
2123-
2124-
| Parameter | Required | Data type | Notes |
2125-
| ---------------- | -------- | ---------- | ---------------------------------------------------------------------------------- |
2126-
| `name` | No | `string` | |
2127-
| `email` | No | `string` | |
2128-
| `avatar` | No | `string` | URL of the Customer's avatar |
2129-
| `session_fields` | No | `[]object` | An array of custom object-enclosed `key:value` pairs. Respects the order of items. |
2130-
2131-
</Text>
2132-
<Code>
2133-
<CodeSample path={'REQUEST'}>
2134-
2135-
```json
2136-
{
2137-
"action": "create_customer",
2138-
"payload": {
2139-
"name": "Thomas Anderson",
2140-
"email": "[email protected]",
2141-
"avatar": "https://example.com/avatars/1.png",
2142-
"session_fields": [{
2143-
"custom_key": "custom_value"
2144-
}, {
2145-
"another_custom_key": "another_custom_value"
2146-
}]
2147-
}
2148-
}
2149-
```
2150-
2151-
</CodeSample>
2152-
2153-
<CodeResponse>
2154-
2155-
```json
2156-
{
2157-
"request_id": "<request_id>", // optional
2158-
"action": "create_customer",
2159-
"type": "response",
2160-
"success": true,
2161-
"payload": {
2162-
"customer_id": "b7eff798-f8df-4364-8059-649c35c9ed0c"
2163-
}
2164-
}
2165-
```
2166-
2167-
</CodeResponse>
2168-
</Code>
2169-
</Section>
2170-
2171-
<Section>
2172-
<Text>
2173-
21742109
### Update Customer
21752110

21762111
Updates Customer's properties.

0 commit comments

Comments
 (0)