Components
Update component text variant
Used for updating the text and status fields for components in the workspace of the requesting user.
-> Currently only supports updating variant text or status on components via the variant query parameter (an error will be thrown if the variant param is not specified)
-> Currently only available for teams on team or enterprise plans
PUT
/
components
Authorizations
Authorization
string
headerrequiredQuery Parameters
variant
string
requiredThe API ID of the variant.
format
enum<string>
Optional parameter to specify the format of the request body. Passing in this query parameter will validate the request body against the specified format preventing unexpected results if an invalid payload is provided.
Available options:
flat
, structured
, nested
Body
application/json
data
object
requiredObject that maps component API IDs to their new attributes.
Response
200 - application/json
componentsUpdated
number
requiredcomponentsSkipped
number
required