Skip to content

Commit 662118e

Browse files
authored
feat(docs): add new params to canned responses
1 parent 184c58f commit 662118e

File tree

2 files changed

+19
-10
lines changed
  • src/pages
    • management/configuration-api/v3.7
    • messaging/agent-chat-api/v3.7/rtm-pushes

2 files changed

+19
-10
lines changed

src/pages/management/configuration-api/v3.7/index.mdx

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4234,14 +4234,16 @@ Returns a paginated list of canned responses.
42344234

42354235
##### Response
42364236

4237-
| Parameter | Data type | Notes |
4238-
| ------------ | --------------- | --------------------------------------- |
4239-
| `id` | `number` | Canned response ID |
4240-
| `text` | `string` | Canned response text content |
4241-
| `tags` | `array[string]` | Array of tags |
4242-
| `group_id` | `number` | Group ID the canned response belongs to |
4243-
| `is_private` | `bool` | Whether the canned response is private |
4244-
| `author_id` | `string` | User ID of the last editor |
4237+
| Parameter | Data type | Notes |
4238+
| ------------ | --------------- | ---------------------------------------------- |
4239+
| `id` | `number` | Canned response ID |
4240+
| `text` | `string` | Canned response text content |
4241+
| `tags` | `array[string]` | Array of tags |
4242+
| `group_id` | `number` | Group ID the canned response belongs to |
4243+
| `is_private` | `bool` | Whether the canned response is private |
4244+
| `author_id` | `string` | User ID of the last editor |
4245+
| `created_at` | `string` | Specifies when the canned response was created |
4246+
| `updated_at` | `string` | Specifies when the canned response was updated |
42454247

42464248
<Code>
42474249

@@ -4272,15 +4274,19 @@ curl -X POST \
42724274
"tags": ["greeting", "support", "updated"],
42734275
"group_id": 1,
42744276
"is_private": true,
4275-
"author_id": "agent123"
4277+
"author_id": "smith@example.com",
4278+
"created_at": "2025-10-17T08:16:45.000000Z",
4279+
"updated_at": "2025-10-17T08:16:45.000000Z",
42764280
},
42774281
{
42784282
"id": 12346,
42794283
"text": "We'll get back to you within 24 hours.",
42804284
"tags": ["follow-up"],
42814285
"group_id": 1,
42824286
"is_private": false,
4283-
"author_id": "agent456"
4287+
"author_id": "smith@example.com",
4288+
"created_at": "2025-10-10T08:16:45.000000Z",
4289+
"updated_at": "2025-22-17T07:11:28.288340Z",
42844290
}
42854291
],
42864292
"found_canned_responses": 25,

src/pages/messaging/agent-chat-api/v3.7/rtm-pushes/index.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1142,6 +1142,8 @@ Informs that a canned response was created. The payload contains the full state
11421142
```json
11431143
{
11441144
"id": 12345,
1145+
"created_at": "2025-22-10T07:11:28.288340Z",
1146+
"updated_at": "2025-22-10T07:11:28.288340Z",
11451147
"text": "Thank you for contacting us! How can I help you today?",
11461148
"tags": ["greeting", "support"],
11471149
"group_id": 1,
@@ -1161,6 +1163,7 @@ Informs that a canned response was updated. The payload contains the updated can
11611163
```json
11621164
{
11631165
"id": 12345,
1166+
"updated_at": "2025-22-10T09:15:06.288340Z",
11641167
"text": "Thank you for contacting us! How may I assist you today?",
11651168
"tags": ["greeting", "support", "updated"],
11661169
"group_id": 1,

0 commit comments

Comments
 (0)