From e53138165a30ac6965523a723117fcf14a98bdc0 Mon Sep 17 00:00:00 2001 From: Oleksandr Tkach Date: Wed, 19 Nov 2025 11:58:54 +0100 Subject: [PATCH 1/3] AC-1596 add translations EP to 3.7 --- .../configuration-api/v3.7/index.mdx | 124 ++++++++++++++++++ 1 file changed, 124 insertions(+) diff --git a/src/pages/management/configuration-api/v3.7/index.mdx b/src/pages/management/configuration-api/v3.7/index.mdx index 4eb1fb2bd..e58d9af93 100644 --- a/src/pages/management/configuration-api/v3.7/index.mdx +++ b/src/pages/management/configuration-api/v3.7/index.mdx @@ -45,6 +45,7 @@ All configurations set by this API will have action in system after max 2 minute | **Tags** | [`create_tag`](#create-tag) [`delete_tag`](#delete-tag) [`list_tags`](#list-tags) [`update_tag`](#update-tag) | | **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) | | **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) | +| **Translations** | [`list_translations`](#list-translations) [`update_translations`](#update-translations) | | **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) | ## Batch requests @@ -163,6 +164,12 @@ curl -X POST \ | [Update Bot](#update-bot) | `https://api.livechatinc.com/v3.7/configuration/action/batch_update_bots` | | [Delete Bot](#delete-bot) | `https://api.livechatinc.com/v3.7/configuration/action/batch_delete_bots` | +#### Batch support for Translations + +| Method | Batch method URL | +| ------------------------------------------- | --------------------------------------------------------------------------------- | +| [Update Translations](#update-translations) | `https://api.livechatinc.com/v3.7/configuration/action/batch_update_translations` | + # Agents 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,123 @@ curl -X POST \ +# Translations + +
+ +### Update Translations + +Updates existing translations. + +#### Specifics + +| | | +| -------------------------------- | ------------------------------------------------------------------------------ | +| Method URL | `https://api.livechatinc.com/v3.7/configuration/action/update_translations` | +| Required scopes | `languages_write` | +| [Batch support](#batch-requests) | Yes | + +#### Request + +| Parameter | Required | Data type | Notes | +| ------------ | -------- | ------------ | ----------------------------- | +| `group_id` | Yes | `number` | ID of the group | +| `language` | Yes | `string` | Language identifier | +| `phrases` | Yes | `object[]` | List of phrases to update | + +#### Response + +Empty response object `{}`. + + + + + +```shell +curl -X POST \ + https://api.livechatinc.com/v3.7/configuration/action/update_translations \ + -H 'Authorization: Bearer ' \ + -H 'Content-Type: application/json' \ + -d '{ + "group_id": 0, + "language": "en", + "phrases": { + "Welcome_title": "Welcome to chat!" + } + }' +``` + + + + + +```json +{} +``` + + + + + +### List Translations + +Returns a list of translations. + +#### Specifics + +| | | +| -------------------------------- | ----------------------------------------------------------------------------- | +| Method URL | `https://api.livechatinc.com/v3.7/configuration/action/list_translations` | +| Required scopes | `languages_read` | +| [Batch support](#batch-requests) | No | + +#### Request + +| Parameter | Required | Data type | Notes | +| ------------ | -------- | ------------ | ----------------------------- | +| `group_id` | Yes | `number` | ID of the group | +| `language` | Yes | `string` | Language identifier | + +#### Response + +| Parameter | Data type | Notes | +| --------------- | ------------ | ------------------- | +| `phrases` | `object[]` | List of phrases | + + + + + +```shell +curl -X POST \ + https://api.livechatinc.com/v3.7/configuration/action/list_translations \ + -H 'Authorization: Bearer ' \ + -H 'Content-Type: application/json' \ + -d '{ + "group_id": 0, + "language": "en" + }' +``` + + + + + +```json +{ + "phrases": { + "Welcome_title": "Welcome to chat", + "Offline_form": "Thank you for contacting us" + } +} +``` + + + + + +
+ # Other ## Methods From 0a80a15e637eb285065ec78853ed652be3a54f85 Mon Sep 17 00:00:00 2001 From: Oleksandr Tkach Date: Tue, 25 Nov 2025 11:27:41 +0100 Subject: [PATCH 2/3] CR fixes --- .../configuration-api/v3.7/index.mdx | 26 +++++++++++++------ 1 file changed, 18 insertions(+), 8 deletions(-) diff --git a/src/pages/management/configuration-api/v3.7/index.mdx b/src/pages/management/configuration-api/v3.7/index.mdx index 5c971865d..8e09fe6a4 100644 --- a/src/pages/management/configuration-api/v3.7/index.mdx +++ b/src/pages/management/configuration-api/v3.7/index.mdx @@ -4532,11 +4532,21 @@ Updates existing translations. #### Request -| Parameter | Required | Data type | Notes | -| ------------ | -------- | ------------ | ----------------------------- | -| `group_id` | Yes | `number` | ID of the group | -| `language` | Yes | `string` | Language identifier | -| `phrases` | Yes | `object[]` | List of phrases to update | +| Parameter | Required | Data type | Notes | +| ---------------------------- | -------- | ------------ | ------------------------------------------------ | +| `group_id` | Yes | `number` | ID of the group | +| `language` | Yes | `string` | Language identifier | +| `phrases`**1** | Yes | `object` | List of phrases to update as key-value pairs | + +**1)** Possible values for the `phrases` object keys: + +| Possible value | Notes | +| ----------------------------------- | --------------------------------------------------------------------------------- | +| `Welcome_title` | Welcome message displayed in the chat widget | +| `Agents_not_available_continuous` | Message displayed in the chat widget when no agents are available | +| `User_in_queue` | Message displayed in the chat widget when all agents have reached their limit | + +The examples given above are illustrative only and do not represent the complete set of supported keys. #### Response @@ -4593,9 +4603,9 @@ Returns a list of translations. #### Response -| Parameter | Data type | Notes | -| --------------- | ------------ | ------------------- | -| `phrases` | `object[]` | List of phrases | +| Parameter | Data type | Notes | +| --------------- | ------------ | ------------------------------------- | +| `phrases` | `object` | List of phrases as key-value pairs | From e79fa11b61e0792cdc828f98fb79dfa3af2adf60 Mon Sep 17 00:00:00 2001 From: Oleksandr Tkach Date: Tue, 25 Nov 2025 12:01:58 +0100 Subject: [PATCH 3/3] update examples --- .../management/configuration-api/v3.7/index.mdx | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/src/pages/management/configuration-api/v3.7/index.mdx b/src/pages/management/configuration-api/v3.7/index.mdx index 8e09fe6a4..dff2e9a22 100644 --- a/src/pages/management/configuration-api/v3.7/index.mdx +++ b/src/pages/management/configuration-api/v3.7/index.mdx @@ -4540,11 +4540,14 @@ Updates existing translations. **1)** Possible values for the `phrases` object keys: -| Possible value | Notes | -| ----------------------------------- | --------------------------------------------------------------------------------- | -| `Welcome_title` | Welcome message displayed in the chat widget | -| `Agents_not_available_continuous` | Message displayed in the chat widget when no agents are available | -| `User_in_queue` | Message displayed in the chat widget when all agents have reached their limit | +| Possible value | Notes | +| ----------------------------------- | --------------------------------| +| `Welcome_title` | Welcome message | +| `Agents_not_available_continuous` | Contact card message | +| `User_in_queue` | Queued customer info | +| `Client` | Default customer name | +| `Embedded_textarea_placeholder` | Message placeholder | +| `Offline_message_sent` | Ticket confirmation message | The examples given above are illustrative only and do not represent the complete set of supported keys.