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.

PATCH /components

cURL

update_base_text

curl --request PATCH \
  --url https://api.dittowords.com/v2/components \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "updates": [
    {
      "developerId": "component-id-1",
      "text": "Hello!"
    }
  ]
}
'

200

{
  "success": true
}

Authorizations

Authorization · string · header · required

Body

application/json

updates · object[] · required

Array of updates to components.

Minimum array length: 1

Show child attributes

variantId · string

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

forceVariantCreation · boolean

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

Response

200

application/json

Returns success status of the update operation

success · boolean · required

Indicates whether the update was successful