widgetic api brand-kit

8 commands for the Brand Kit operations of the REST API, generated from its OpenAPI description.

widgetic api brand-kit <command> runs the Brand Kit operations of the REST API. It has 8 commands. Every command also takes the flags every command takes.

​

widgetic api brand-kit delete-brand-kit

Reset the Brand Kit to the default

• Request: DELETE /brand-kit
• Operation: deleteBrandKit (widgetic api call deleteBrandKit runs it by that name)
• Works with any API key.
• It deletes something, so it asks first; without a terminal it needs --yes.

Flag	Takes	Required	What it does
--organization-id <uuid>	uuid

The whole description and the schemas: widgetic schema api brand-kit delete-brand-kit.

​

widgetic api brand-kit delete-brand-kit-asset

Remove a font or icon from the Brand Kit

• Request: DELETE /brand-kit/assets/{assetId}
• Operation: deleteBrandKitAsset (widgetic api call deleteBrandKitAsset runs it by that name)
• Works with any API key.
• It deletes something, so it asks first; without a terminal it needs --yes.

Flag	Takes	Required	What it does
--asset-id <uuid>	uuid	yes
--organization-id <uuid>	uuid

The whole description and the schemas: widgetic schema api brand-kit delete-brand-kit-asset.

​

widgetic api brand-kit get-brand-kit

The Brand Kit of the current workspace

• Request: GET /brand-kit
• Operation: getBrandKit (widgetic api call getBrandKit runs it by that name)
• Also written: widgetic api brand-kit list
• Works with any API key.

Flag	Takes	Required	What it does
--organization-id <uuid>	uuid		An organisation’s kit; omit for the caller’s current workspace.

The whole description and the schemas: widgetic schema api brand-kit get-brand-kit.

​

widgetic api brand-kit patch-brand-kit

Change part of the Brand Kit

• Request: PATCH /brand-kit
• Operation: patchBrandKit (widgetic api call patchBrandKit runs it by that name)
• Works with any API key.

Flag	Takes	Required	What it does
--organization-id <uuid>	uuid
--corner-radius <int>	integer		One corner radius in pixels for the whole kit; the small, medium and large radii are made from it. 0 gives square corners. A radius step sent in spacing wins over the one made from this value.
--instructions <text>	text		The kit owner’s style notes (see tokens.instructions). An empty string removes them.
--expected-version <int>	integer		Refuse the change with a 409 when the kit was saved again since this version was read.
--data <json|@file|->	JSON, @path or -		The whole request document as JSON, @path to a file that holds it, or - for standard input. The flags above override its keys.

The whole description and the schemas: widgetic schema api brand-kit patch-brand-kit.

​

widgetic api brand-kit patch-brand-kit-asset

Rename an icon or relabel a font variant

• Request: PATCH /brand-kit/assets/{assetId}
• Operation: patchBrandKitAsset (widgetic api call patchBrandKitAsset runs it by that name)
• Works with any API key.

Flag	Takes	Required	What it does
--asset-id <uuid>	uuid	yes
--organization-id <uuid>	uuid
--name <text>	text		Icon rename
--family <text>	text		Font family relabel
--weight <int>	integer
--style <text>	one of normal, italic
--data <json|@file|->	JSON, @path or -		The whole request document as JSON, @path to a file that holds it, or - for standard input. The flags above override its keys.

The whole description and the schemas: widgetic schema api brand-kit patch-brand-kit-asset.

​

widgetic api brand-kit post-brand-kit-font

Upload a font file to the Brand Kit

• Request: POST /brand-kit/fonts
• Operation: postBrandKitFont (widgetic api call postBrandKitFont runs it by that name)
• Works with any API key.

Flag	Takes	Required	What it does
--organization-id <uuid>	uuid
--file <path>	path of a file	yes
--family <text>	text	yes
--weight <int>	integer	yes
--style <text>	one of normal, italic

The whole description and the schemas: widgetic schema api brand-kit post-brand-kit-font.

​

widgetic api brand-kit post-brand-kit-icon

Add a named SVG icon to the Brand Kit

• Request: POST /brand-kit/icons
• Operation: postBrandKitIcon (widgetic api call postBrandKitIcon runs it by that name)
• Works with any API key.

Flag	Takes	Required	What it does
--organization-id <uuid>	uuid
--name <text>	text
--svg <text>	text
--data <json|@file|->	JSON, @path or -		The whole request document as JSON, @path to a file that holds it, or - for standard input. The flags above override its keys.

The whole description and the schemas: widgetic schema api brand-kit post-brand-kit-icon.

​

widgetic api brand-kit put-brand-kit

Save Brand Kit tokens

• Request: PUT /brand-kit
• Operation: putBrandKit (widgetic api call putBrandKit runs it by that name)
• Works with any API key.

Flag	Takes	Required	What it does
--organization-id <uuid>	uuid
--expected-version <int>	integer
--data <json|@file|->	JSON, @path or -		The whole request document as JSON, @path to a file that holds it, or - for standard input. The flags above override its keys.

The whole description and the schemas: widgetic schema api brand-kit put-brand-kit.