Branding kits

List, create, update and delete branding kits.

list_kits

List an organization’s branding kits. Maps to GET /organizations/:org/kits.

NameTypeRequiredDescription
orgstringYesOrganization 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.

NameTypeRequiredDescription
orgstringYesOrganization id (org_…) or slug
namestringYesKit 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.

NameTypeRequiredDescription
orgstringYesOrganization id (org_…) or slug
kit_idstringYesThe kit to update
namestringNo
brandingobjectNoEvery field below

branding, all fields required:

FieldTypeDescription
faviconstring (URL)
logostring (URL)
og_imagestring (URL)
og_image_widthintegerPositive
og_image_heightintegerPositive
primary_color_lightstring#rrggbb
primary_color_darkstring#rrggbb
taglinestring
descriptionstring

Returns the updated kit.

delete_kit

Delete a branding kit. Maps to DELETE /organizations/:org/kits/:kit_id.

NameTypeRequiredDescription
orgstringYesOrganization id (org_…) or slug
kit_idstringYesThe kit to delete

Returns OK (no content).