Set the logo

PUT/api/v1/branding/logo

PUT /branding/logo

curl -X PUT 'https://www.unitpost.com/api/v1/branding/logo' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0' \
  -H 'Content-Type: application/json' \
  -d '{ }'

Response · 200

{
  "object": "branding",
  "company_name": "string",
  "company_address": "string",
  "logo_url": "https://example.com",
  "has_brand_logo": false,
  "colors": {
    "background": "string",
    "footer_background": "string",
    "text": "string",
    "accent": "string",
    "button_text": "string"
  },
  "font": "string",
  "hide_unitpost_branding": false,
  "unitpost_branding_hidden": false,
  "can_hide_unitpost_branding": false,
  "unsubscribe_page": {
    "title": "string",
    "description": "string",
    "confirm": false,
    "collect_reason": false,
    "show_address": false,
    "show_topics": false,
    "save_label": "string",
    "global_label": "string",
    "global_note": "string",
    "topics_heading": "string"
  },
  "footer": {
    "intro_text": "string",
    "unsubscribe_label": "string"
  }
}

Replace the logo marketing emails and the unsubscribe page show, from a public https url or base64 data (PNG, JPEG, GIF or WebP, up to 5 MB and 16,384 px a side). Requires the branding:write capability.

Request body4 fields

Field	Type	Description
`url`	string	A public https image to fetch (no redirects, no private addresses). PNG, JPEG, GIF or WebP, up to 5 MB and 16,384 px a side (50 megapixels at most); anything else is a 422 naming `url`.
`data`	string	The image bytes, base64 (no `data:` prefix). Base64 adds a third, and a request over ~6 MB is refused before it arrives, so this fits about 4 MB of image; send larger images (up to 5 MB) by `url`. At most 16,384 px a side and 50 megapixels; anything else is a 422 naming `data`.
`content_type`	enumimage/png \| image/jpeg \| image/gif \| image/webp	Required with `data`; refused with `url` (the server sends the type).
`filename`	string	Shown in the library. Defaults to the URL's file name, or `image`.

Response · 200 fields12 fields

Field	Type	Description
`object`required	string	—
`company_name`required	string \| null	The name the footer shows; the workspace's name unless one was set.
`company_address`required	string \| null	—
`logo_url`required	string \| null	The logo emails and the unsubscribe page show: the brand logo, else the workspace image, else none.
`has_brand_logo`required	boolean	—
`colors`required	object	—
`font`required	string \| null	—
`hide_unitpost_branding`required	boolean	The stored choice.
`unitpost_branding_hidden`required	boolean	Whether recipients see no mark now: the choice, the plan and the account together.
`can_hide_unitpost_branding`required	boolean	Whether the plan allows hiding the mark.
`unsubscribe_page`required	object	—
`footer`required	object	—

200400401403422429502503

Set the logo

Set the logo

Search docs and guides