Update translation

Updates an existing translation record with automatic redirect creation for slug changes when enabled

PUT/api/v1/{team_slug}/{app_slug}/translations/{translation_id}
API
Management
Updated
Apr 26, 2026

management-api:PUT:/api/v1/{team_slug}/{app_slug}/translations/{translation_id}

Updates an existing translation record with automatic redirect creation for slug changes when enabled

API ownership

  • API family: Management API
  • Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data.
  • Do not use from: Browser-only storefront code or public clients.
  • Guide route: /apis/management/latest

The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.

Operation

  • Method: PUT
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/translations/\{translation_id\}
  • Summary: Update translation
  • Description: Updates an existing translation record with automatic redirect creation for slug changes when enabled
  • OpenAPI contract: management-api
  • Operation ID: Not documented in the OpenAPI contract.

Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.

Parameters3 parameters
NameInRequiredTypeDescription
app_slugpathYesstringApp slug
team_slugpathYesstringTeam slug
translation_idpathYesstringtranslation uuid
Request bodyDocumented body
  • Required: Yes
  • Description: Translation data
  • Content: application/json (object)

Update Translation Body

PropertyTypeRequiredDetails
create_slugbooleanNoif this is true and with the fieldType: name, it will generate a slug. Only available to products as of now.
field_typeenum("name", "value", "description", "alt", "title", "type", "copyright", "slug", "meta_title", "meta_description", "html_description", "short_description", "html_short_description", "key")Yes-
language_codestringYesLocale code like "en" or "en-gb". The locale also needs to be configured and supported by the app.
parent_refstringYes-
parent_typeenum("product", "product_bundle", "product_variant", "image", "attribute", "attribute_value", "category", "tag", "collection", "file", "bundle_group", "video", "brand", "variant_group", "channel_content")No-
translationstringYes-

Generated example (synthetic):

{
  "create_slug": false,
  "field_type": "name",
  "language_code": "string",
  "parent_ref": "string",
  "parent_type": "product",
  "translation": "string"
}
Responses4 statuses
StatusDescriptionContent
200Translation updates successfullyapplication/json (object)
400Invalid request (e.g. bad UUID, validation error)application/json (object)
401Unauthorized accessapplication/json (object)
500Internal server errorapplication/json (object)

200 - object

Translation

PropertyTypeRequiredDetails
field_typeenum("name", "value", "description", "alt", "title", "type", "copyright", "slug", "meta_title", "meta_description", "html_description", "short_description", "html_short_description", "key")Yes-
idstringNo-
language_codestringYes-
parent_refstringYes-
parent_typeenum("product", "product_bundle", "product_variant", "channel_content", "image", "attribute", "attribute_value", "category", "tag", "collection", "file", "bundle_group", "video", "brand", "variant_group")Yes-
translationstringYes-

Generated example (synthetic):

{
  "field_type": "name",
  "id": "string",
  "language_code": "string",
  "parent_ref": "string",
  "parent_type": "product",
  "translation": "string"
}

400 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

401 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

500 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

Contract identity

Use these fields to confirm you are implementing the intended endpoint contract.

  • API family: Management API
  • Method: PUT
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/translations/\{translation_id\}
  • Operation ID: Not documented in the OpenAPI contract.
  • OpenAPI tag: Translations
  • OpenAPI summary: Update translation

Update translation

# Update translation Updates an existing translation record with automatic redirect creation for slug changes when enabled
PUT /api/v1/{team_slug}/{app_slug}/translations/{translation_id}
Purpose

Updates an existing translation record with automatic redirect creation for slug changes when enabled

Required inputs

app_slug path team_slug path translation_id path

Primary response

200 ยท Translation updates successfully

Operation key

management-api:PUT:/api/v1/{team_slug}/{app_slug}/translations/{translation_id}

## API ownership - API family: Management API - Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data. - Do not use from: Browser-only storefront code or public clients. - Guide route: [/apis/management/latest](/apis/management/latest) The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation. ## Operation - Method: `PUT` - Path: `/api/v1/{team_slug}/{app_slug}/translations/{translation_id}` - Summary: Update translation - Description: Updates an existing translation record with automatic redirect creation for slug changes when enabled - OpenAPI contract: management-api - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:PUT:/api/v1/{team_slug}/{app_slug}/translations/{translation_id}` Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID. ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | app_slug | path | Yes | string | App slug | | team_slug | path | Yes | string | Team slug | | translation_id | path | Yes | string | translation uuid | ## Request body - Required: Yes - Description: Translation data - Content: application/json (object) ### Update Translation Body | Property | Type | Required | Details | | --- | --- | --- | --- | | `create_slug` | boolean | No | if this is true and with the fieldType: name, it will generate a slug. Only available to products as of now. | | `field_type` | enum("name", "value", "description", "alt", "title", "type", "copyright", "slug", "meta_title", "meta_description", "html_description", "short_description", "html_short_description", "key") | Yes | - | | `language_code` | string | Yes | Locale code like "en" or "en-gb". The locale also needs to be configured and supported by the app. | | `parent_ref` | string | Yes | - | | `parent_type` | enum("product", "product_bundle", "product_variant", "image", "attribute", "attribute_value", "category", "tag", "collection", "file", "bundle_group", "video", "brand", "variant_group", "channel_content") | No | - | | `translation` | string | Yes | - | **Generated example (synthetic):** ```json { "create_slug": false, "field_type": "name", "language_code": "string", "parent_ref": "string", "parent_type": "product", "translation": "string" } ``` ## Responses | Status | Description | Content | | --- | --- | --- | | 200 | Translation updates successfully | application/json (object) | | 400 | Invalid request (e.g. bad UUID, validation error) | application/json (object) | | 401 | Unauthorized access | application/json (object) | | 500 | Internal server error | application/json (object) | ### 200 - object #### Translation | Property | Type | Required | Details | | --- | --- | --- | --- | | `field_type` | enum("name", "value", "description", "alt", "title", "type", "copyright", "slug", "meta_title", "meta_description", "html_description", "short_description", "html_short_description", "key") | Yes | - | | `id` | string | No | - | | `language_code` | string | Yes | - | | `parent_ref` | string | Yes | - | | `parent_type` | enum("product", "product_bundle", "product_variant", "channel_content", "image", "attribute", "attribute_value", "category", "tag", "collection", "file", "bundle_group", "video", "brand", "variant_group") | Yes | - | | `translation` | string | Yes | - | **Generated example (synthetic):** ```json { "field_type": "name", "id": "string", "language_code": "string", "parent_ref": "string", "parent_type": "product", "translation": "string" } ``` ### 400 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 401 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 500 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ## Contract identity Use these fields to confirm you are implementing the intended endpoint contract. - API family: Management API - Method: `PUT` - Path: `/api/v1/{team_slug}/{app_slug}/translations/{translation_id}` - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:PUT:/api/v1/{team_slug}/{app_slug}/translations/{translation_id}` - OpenAPI tag: Translations - OpenAPI summary: Update translation