marketing

Save the account's brand kit

Set the brand a marketing video signs with: the name on the pill, the accent colour, the default closing line, and optionally a palette, a font, a copy language and a tone. The whole kit is REPLACED, not merged — name and accent are always required, and a half left out of palette/font/copyLanguage/tone keeps what the row already had. The house copy rule is enforced here: no dashes in the name or the call to action, because the designs set them in type that has no dash. The logo is not set here: files are not part of v1.0.

put/marketing/brand-kit

Request

  • Base URL: https://api.gogoscreen.com/api/v1
  • URL: https://api.gogoscreen.com/api/v1/marketing/brand-kit
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Headers

Idempotency-Keystring required

1–128 characters, unique to this request. A retry with the same key and the same body returns the STORED response with Idempotent-Replayed: true; the same key with a different body is 409 idempotency_conflict; a duplicate still in flight is 409 idempotency_in_progress. Claims expire after 24 hours.

Request body

accentstring required

The accent colour as #rrggbb.

copyLanguagestring nullable

A language tag such as en or fr-CA.

defaultCtastring nullable

The closing line when a video does not name one. No dashes.

fontstring nullable

A font id from the marketing catalogue.

namestring required

The name on the brand pill. No dashes.

palettestring[] nullable

Up to four colours. The accent leads it; two entries are the band and the panel.

tonestring nullable

Response

Save the account's brand kit

brandKitobject required

Changes

No recorded changes to this operation across all 1 revision of this API.