Skip to main content
PUT
Update brand

Authorizations

X-Auth-Token
string
header
required

API token generated at Settings > API

Path Parameters

id
integer
required

Body

application/json
name
string
Maximum string length: 120
branding
object

A set of signing-page and email branding keys, stored on a custom domain (CustomDomain.branding) or a named brand (Brand.branding). Only these keys are accepted; an unknown key, a wrong type, a non-http(s) URL or a header_color that is not a dark #rrggbb is rejected with 422. Resolved when the page or email is rendered, so an edit applies to signers who have not finished yet.

Response

Updated brand

brand
object

A named set of branding for accounts that sign on behalf of more than one brand. A template or submission uses it by setting preferences.brand_id to its id.