Components

Update components

Updates a set of components' base or variant text, plural forms, tags, status, assignee, notes, character limit, integrated, and variables.

Each component is identified by its developer ID. Only provided fields are modified — omitted fields remain unchanged.

A developer ID can appear at most once in updates. A request that repeats a developer ID is rejected with a 400 rather than silently applying the last write and discarding the rest — combine the changes into a single update instead.

patch/components

Request

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

Request body

variantIdstring

Developer ID of the target variant. If a component 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: /, /, , <s>, and for line breaks. and 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": "component-id-1",
      "text": "Updated text",
      "status": "REVIEW"
    }
  ]
}

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.