auto_write

Changes the store's brand kit, only in the fields given; it is made if there is none. Colours are hex values for five na

Changes the store's brand kit, only in the fields given; it is made if there is none. Colours are hex values for five named roles, fonts come from a fixed list, the logo is an image in the studio library. The voice, look and rules are instructions the designer composes by. Returns the values the changed fields held before; a colour or font that had none is not among them. Designs already made keep their own brand. Costs no credits.

post/api/v1/tools/update_brand_kit

Request

  • Base URL: https://app.magistry.io
  • URL: https://app.magistry.io/api/v1/tools/update_brand_kit
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.magistry.io/api/oauth/authorize, token URL https://app.magistry.io/api/oauth/token, scopes: creative:write)

Request body

namestring

The kit's name.

logo_media_idstring nullable

An image in the studio library; null removes the logo.

voicestring nullable

How the brand speaks, in a sentence or two.

aestheticstring nullable

The look in a sentence ("warm, minimal, lots of white").

music_moodstring nullable

The mood of the instrumental track a new video is made with, unless the request names its own.

do_liststring[]

Rules the designer always follows. Replaces the whole list.

dont_liststring[]

Things the designer never does. Replaces the whole list.

requires_logoboolean

Tell the designer to put the logo on every design.

disclaimerstring nullable

Small print the designer is told to include.

Response

Tool result

okboolean required
resultunknown required

Changes

No recorded changes to this operation across all 2 revisions of this API.