Skip to main content
PUT
Set a macro translation
Send the translated title and content (HTML, like a macro body). Keep the macro’s {{variables}} as written. options relabels the macro’s options by id; leave it out to keep the current translated labels. An option you don’t list is sent with its original label. Your wording is used exactly like a generated translation: agents get it in the inbox for customers in that language. It is kept until the macro’s title, content or options change, or a custom variable it uses changes. Then the macro is translated again. Retranslate a macro also replaces it with a generated translation. Each change is recorded in the audit log. The response is the macro’s translations, as returned by Get macro translations. It fails with 400 when the language is not one of the chosen ones, or is the language the macro is written in.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

Macro ID

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
language
string
required

Language code (lower-case, such as es), one of the selected translation_languages.

Pattern: ^[a-z]{2,3}$

Body

application/json
title
string
required

The translated title.

Required string length: 1 - 120
content
string
required

The translated body, HTML like a macro body (<p>, <br>, <strong>, <em>, <s>, <a href>, lists, inline images). Keep {{variables}} as written.

Required string length: 1 - 20000
options
object[]

Translated labels for the macro's options, by option id (up to 20 characters each). Leave out to keep the current translated labels; an option not listed is sent with its original label.

Response

Default Response

saved_reply_id
string
required
source_language
string | null
required
items
object[]
required