Skip to content

Translations API

Update a translation

PATCHhttps://email.growthdept.ai/api/translations/{id}

Changes the locales or writes the translated values ([{id, source, translations: {<locale>: text}}]).

Ask for values with additional-fields[translation]; they are left out unless you do.

The request body can be up to 5 MB.

Rate limits

Burst: 10/s

Steady: 150/m

Tier M. See rate limits for how requests are counted.

Scopes

translations:write

Operation id

update_translation The same operation as in Klaviyo's API. OpenAPI document

Path parameters

stringrequired

Query parameters

array of strings

Attributes left out unless asked for.

Additional fields guide

Pick values to add them to the request:

array of strings

Attributes of translation resources to return.

Sparse fieldsets guide

Pick values to add them to the request:

Body

Send application/vnd.api+json or application/json.

object

  • dataobjectrequired

    data: 5 fields
    • typestringrequired

      translation
    • idstringrequired

    • attributesobjectrequired

      attributes: 4 fields
      • source_localestringcan be null

      • target_localesarray of strings

      • fallback_localestringcan be null

      • valuesarray of objects

    • relationshipsobject

    • metaobject

Edit the example. The code samples use what you type here.

Headers

stringrequireddefault 2026-10-15

API revision, YYYY-MM-DD. This server implements 2026-10-15.

Revisions guide

Responses

200Success

Response body

object

  • dataobjectrequired

    data: 5 fields
    • typestringrequired

      translation
    • idstringrequired

    • attributesobjectrequired

      attributes: 8 fields
      • source_localestringrequired

      • target_localesarray of stringsrequired

      • fallback_localestringcan be null

      • channelstringrequired

        emailmobile_pushsmswebwhatsapp
      • metadataobjectcan be null

      • createdstring (date-time)can be null

      • updatedstring (date-time)can be null

      • valuesarray of objectscan be null

    • relationshipsobject

      relationships: 5 fields
      • campaign-variationobject

        campaign-variation: 2 fields
        • dataobject

          data: 2 fields
          • typestringrequired

            campaign-variation
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

      • flow-messageobject

        flow-message: 2 fields
        • dataobject

          data: 2 fields
          • typestringrequired

            flow-message
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

      • templateobject

        template: 2 fields
        • dataobject

          data: 2 fields
          • typestringrequired

            template
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

      • template-universal-contentobject

        template-universal-content: 2 fields
        • dataobject

          data: 2 fields
          • typestringrequired

            template-universal-content
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

      • consent-pageobject

        consent-page: 2 fields
        • dataobject

          data: 2 fields
          • typestringrequired

            consent-page
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

    • linksobjectrequired

      links: 1 field
      • selfstring (uri)required

  • linksobject

    links: 1 field
    • selfstring (uri)required

  • metaobject

4XXClient error

Response body

object

  • errorsarray of objectsrequired

    errors: 8 fields
    • idstringrequired

    • statusintegerrequired

    • codestringrequired

    • titlestringrequired

    • detailstringrequired

    • sourceobject

      source: 2 fields
      • pointerstring

      • parameterstring

    • linksobject

    • metaobject

See status codes for each code.

5XXServer error

Response body

object

  • errorsarray of objectsrequired

    errors: 8 fields
    • idstringrequired

    • statusintegerrequired

    • codestringrequired

    • titlestringrequired

    • detailstringrequired

    • sourceobject

      source: 2 fields
      • pointerstring

      • parameterstring

    • linksobject

    • metaobject