Skip to content

Commit 8d4552c

Browse files
otkach-textotkach-text
authored
feat(docs): add translations methods to 3.7 (#1621)
1 parent 4f05d89 commit 8d4552c

File tree

2 files changed

+141
-0
lines changed

2 files changed

+141
-0
lines changed

‎src/pages/management/changelog/index.mdx‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,12 @@ The developer preview version provides a preview of the upcoming changes to the
3737
- [**List Canned Responses**](/management/configuration-api/v3.7#list-canned-responses)
3838
- [**Delete Canned Response**](/management/configuration-api/v3.7#delete-canned-response)
3939

40+
### Translations
41+
42+
- Added translations management methods:
43+
- [**Update Translations**](/management/configuration-api/v3.7#update-translations)
44+
- [**List Translations**](/management/configuration-api/v3.7#list-translations)
45+
4046
## [v3.6] - 2025-08-07
4147

4248
### Agents

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

Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ All configurations set by this API will have action in system after max 2 minute
4545
| **Tags** | [`create_tag`](#create-tag) [`delete_tag`](#delete-tag) [`list_tags`](#list-tags) [`update_tag`](#update-tag) |
4646
| **Webhooks** | [`register_webhook`](#register-webhook) [`list_webhooks`](#list-webhooks) [`unregister_webhook`](#unregister-webhook) [`list_webhook_names`](#list-webhook-names) [`enable_license_webhook`](#enable-license-webhooks) [`disable_license_webhook`](#disable-license-webhooks) [`get_license_webhooks_state`](#get-license-webhooks-state) |
4747
| **Canned responses** | [`create_canned_response`](#create-canned-response) [`list_canned_responses`](#list-canned-responses) [`update_canned_response`](#update-canned-response) [`delete_canned_response`](#delete-canned-response) |
48+
| **Translations** | [`list_translations`](#list-translations) [`update_translations`](#update-translations) |
4849
| **Other** | [`list_channels`](#list-channels) [`check_product_limits_for_plan`](#check-product-limits-for-plan) [`reactivate_email`](#reactivate-email) [`update_company_details`](#update-company-details) |
4950

5051
## Batch requests
@@ -163,6 +164,12 @@ curl -X POST \
163164
| [Update Bot](#update-bot) | `https://api.livechatinc.com/v3.7/configuration/action/batch_update_bots` |
164165
| [Delete Bot](#delete-bot) | `https://api.livechatinc.com/v3.7/configuration/action/batch_delete_bots` |
165166

167+
#### Batch support for Translations
168+
169+
| Method | Batch method URL |
170+
| ------------------------------------------- | --------------------------------------------------------------------------------- |
171+
| [Update Translations](#update-translations) | `https://api.livechatinc.com/v3.7/configuration/action/batch_update_translations` |
172+
166173
# Agents
167174

168175
An agent is a type of user who communicates with customers. You can look up the sample agent data structure in the [response of Get Agent](#get-agent).
@@ -4507,6 +4514,134 @@ curl -X POST \
45074514

45084515
</Section>
45094516

4517+
# Translations
4518+
4519+
<Section>
4520+
4521+
### Update Translations
4522+
4523+
Updates existing translations.
4524+
4525+
#### Specifics
4526+
4527+
| | |
4528+
| -------------------------------- | ------------------------------------------------------------------------------ |
4529+
| Method URL | `https://api.livechatinc.com/v3.7/configuration/action/update_translations` |
4530+
| Required scopes | `languages_write` |
4531+
| [Batch support](#batch-requests) | Yes |
4532+
4533+
#### Request
4534+
4535+
| Parameter | Required | Data type | Notes |
4536+
| ---------------------------- | -------- | ------------ | ------------------------------------------------ |
4537+
| `group_id` | Yes | `number` | ID of the group |
4538+
| `language` | Yes | `string` | Language identifier |
4539+
| `phrases`<sup>**1**</sup> | Yes | `object` | List of phrases to update as key-value pairs |
4540+
4541+
**1)** Possible values for the `phrases` object keys:
4542+
4543+
| Possible value | Notes |
4544+
| ----------------------------------- | --------------------------------|
4545+
| `Welcome_title` | Welcome message |
4546+
| `Agents_not_available_continuous` | Contact card message |
4547+
| `User_in_queue` | Queued customer info |
4548+
| `Client` | Default customer name |
4549+
| `Embedded_textarea_placeholder` | Message placeholder |
4550+
| `Offline_message_sent` | Ticket confirmation message |
4551+
4552+
#### Response
4553+
4554+
Empty response object `{}`.
4555+
4556+
<Code>
4557+
4558+
<CodeSample path={'REQUEST'}>
4559+
4560+
```shell
4561+
curl -X POST \
4562+
https://api.livechatinc.com/v3.7/configuration/action/update_translations \
4563+
-H 'Authorization: Bearer <your_access_token>' \
4564+
-H 'Content-Type: application/json' \
4565+
-d '{
4566+
"group_id": 0,
4567+
"language": "en",
4568+
"phrases": {
4569+
"Welcome_title": "Welcome to chat!"
4570+
}
4571+
}'
4572+
```
4573+
4574+
</CodeSample>
4575+
4576+
<CodeResponse>
4577+
4578+
```json
4579+
{}
4580+
```
4581+
4582+
</CodeResponse>
4583+
4584+
</Code>
4585+
4586+
### List Translations
4587+
4588+
Returns a list of all translations.
4589+
4590+
#### Specifics
4591+
4592+
| | |
4593+
| -------------------------------- | ----------------------------------------------------------------------------- |
4594+
| Method URL | `https://api.livechatinc.com/v3.7/configuration/action/list_translations` |
4595+
| Required scopes | `languages_read` |
4596+
| [Batch support](#batch-requests) | No |
4597+
4598+
#### Request
4599+
4600+
| Parameter | Required | Data type | Notes |
4601+
| ------------ | -------- | ------------ | ----------------------------- |
4602+
| `group_id` | Yes | `number` | ID of the group |
4603+
| `language` | Yes | `string` | Language identifier |
4604+
4605+
#### Response
4606+
4607+
| Parameter | Data type | Notes |
4608+
| --------------- | ------------ | ------------------------------------- |
4609+
| `phrases` | `object` | List of phrases as key-value pairs |
4610+
4611+
<Code>
4612+
4613+
<CodeSample path={'REQUEST'}>
4614+
4615+
```shell
4616+
curl -X POST \
4617+
https://api.livechatinc.com/v3.7/configuration/action/list_translations \
4618+
-H 'Authorization: Bearer <your_access_token>' \
4619+
-H 'Content-Type: application/json' \
4620+
-d '{
4621+
"group_id": 0,
4622+
"language": "en"
4623+
}'
4624+
```
4625+
4626+
</CodeSample>
4627+
4628+
<CodeResponse>
4629+
4630+
```json
4631+
{
4632+
"phrases": {
4633+
"Welcome_title": "Welcome to chat",
4634+
"Offline_form": "Thank you for contacting us"
4635+
}
4636+
}
4637+
```
4638+
4639+
</CodeResponse>
4640+
4641+
</Code>
4642+
4643+
</Section>
4644+
45104645
# Other
45114646

45124647
## Methods

0 commit comments

Comments
 (0)