Branding kits
List, create, update and delete branding kits.
list_kits
List an organization’s branding kits. Maps to GET /organizations/:org/kits.
| Name | Type | Required | Description |
|---|---|---|---|
org | string | Yes | Organization id (org_…) or slug |
Returns the list of kits.
create_kit
Create a branding kit. Only the name is set here; branding starts from the
default and is edited with update_kit. Maps to POST /organizations/:org/kits.
| Name | Type | Required | Description |
|---|---|---|---|
org | string | Yes | Organization id (org_…) or slug |
name | string | Yes | Kit name, e.g. Acme |
Returns the created kit.
update_kit
Change a kit’s name or branding. Branding is replaced whole when given. Maps to
PATCH /organizations/:org/kits/:kit_id.
| Name | Type | Required | Description |
|---|---|---|---|
org | string | Yes | Organization id (org_…) or slug |
kit_id | string | Yes | The kit to update |
name | string | No | |
branding | object | No | Every field below |
branding, all fields required:
| Field | Type | Description |
|---|---|---|
favicon | string (URL) | |
logo | string (URL) | |
og_image | string (URL) | |
og_image_width | integer | Positive |
og_image_height | integer | Positive |
primary_color_light | string | #rrggbb |
primary_color_dark | string | #rrggbb |
tagline | string | |
description | string |
Returns the updated kit.
delete_kit
Delete a branding kit. Maps to DELETE /organizations/:org/kits/:kit_id.
| Name | Type | Required | Description |
|---|---|---|---|
org | string | Yes | Organization id (org_…) or slug |
kit_id | string | Yes | The kit to delete |
Returns OK (no content).