Apply the brand kit to forms
apply_brand_kitPut the brand kit on these forms, live at once, published or not: their own logo, colours and type are replaced by the kit, and their themePreset (the editor's note of the last preset picked) is cleared, because it no longer describes their colours. revert_brand_kit brings back the look each form had before. Destructive: it deletes or replaces data, so it is best confirmed with the user first, naming exactly what will change. After an error or a timeout, a read shows whether the change went through, so a blind retry is not needed. Owners and admins only.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"form_ids": "<form_ids>"
},
"name": "apply_brand_kit"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| form_ids | Yes | The forms, 1 to 500 ids from list_forms. | |
| workspace_id | No | The workspace this call acts in: an id from list_my_workspaces. Required for a person signed in with several workspaces and for staff of this deployment; optional with an API key or with only one workspace. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| applied | Yes | The forms the kit was applied to. Ids of other workspaces are skipped, and nothing applies without a kit. | |
| workspace | Yes | The workspace this call acted in, to compare with the one the user means. |