Branding

Retrieve branding

GET/api/v1/branding

GET /branding

curl -X GET 'https://www.unitpost.com/api/v1/branding' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'

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"
  }
}

The look marketing emails' footer and the hosted unsubscribe page share, as Settings → Brand shows it: colors, the font, the company name and postal address, the page's copy and behavior, the footer's labels, the logo, and whether the "Sent with Unitpost" mark shows. null means the default; company_name falls back to the workspace's name, so send it only to pin a different one. Requires the templates:read capability.

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	—

200401403422

Update branding

PATCH/api/v1/branding

PATCH /branding

curl -X PATCH 'https://www.unitpost.com/api/v1/branding' \
  -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"
  }
}

Change branding with the same options Settings → Brand offers; only the fields you send change, and null restores a default. The footer every marketing email carries is built from these at send (it always keeps the unsubscribe link and the postal address). Hiding the "Sent with Unitpost" mark needs a paid plan (403 limit_reached). No key preset includes this capability: tick it on the key. Requires the branding:write capability.

Request body7 fields

Field	Type	Description
`company_name`	string \| null	Shown in the footer (`{{company_name}}`).
`company_address`	string \| null	The postal address every marketing email carries (`{{company_address}}`).
`colors`	object	—
`font`	enum \| null	One of: System default, Arial, Helvetica, Verdana, Tahoma, Trebuchet MS, Georgia, Times New Roman, Courier New.
`hide_unitpost_branding`	boolean	Hide the "Sent with Unitpost" mark. Paid plans only (403 `limit_reached`).
`unsubscribe_page`	object	—
`footer`	object	—

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	—

200400401403422

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

Remove the logo

DELETE/api/v1/branding/logo

DELETE /branding/logo

curl -X DELETE 'https://www.unitpost.com/api/v1/branding/logo' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'

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"
  }
}

Clear the brand logo: the workspace image shows instead, else none. Requires the branding:write capability.

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	—

200401403

Branding

Retrieve branding

Update branding

Set the logo

Remove the logo

Search docs and guides