Text Items

Update text items

Updates a set of text items' base or variant text, tags, status, assignee, and plural forms.

Deprecated — use PATCH /textItems instead.

put/textItems

Request

  • Base URL: https://api.dittowords.com/v2
  • URL: https://api.dittowords.com/v2/textItems
  • Auth: API key in header Authorization

Request body

variantIdstring

Developer ID of the target variant. If a text item does not already have the target variant, it will be added. Omit if targeting base text.

forceVariantCreationboolean

If true, and the provided variantId is not found, create the variant. A variant name will be generated based on the passed in ID.

richText'html'

When set to 'html', all text values in this request (including plural text) are parsed as HTML and saved as rich text. Supported formatting: <strong>/<b>, <em>/<i>, <u>, <s>, and <br> for line breaks. <sup> and <sub> are only supported for workspaces with superscript and subscript enabled. Unsupported markup (for example links, lists, or headings) is dropped and its text content kept.

Note: Fully-bolded strings will have that bold styling stripped, as Figma does not support bolding an entire text layer this way.

When omitted, text is saved as plaintext and any markup is stored literally.

Example request

{
  "variantId": "french",
  "updates": [
    {
      "developerId": "greeting",
      "text": "Bonjour!",
      "status": "FINAL",
      "assignee": "john@example.com"
    }
  ]
}

Response

Returns success status of the update operation

successboolean required

Indicates whether the update was successful

Example response

{
  "success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.