Brand

The Brand object allows you to customize the publicly-accessible HMTL page that shows tracking details for every EasyPost tracker.

You can change your log, brand color, include an ad to keep your customers engaged, as well as some other theme-specific details to customize the way your tracking pages will look.

Your Brand can be set from the EasyPost dashboard or via the API.

Endpoints

PATCH

/users/:id/brand

Brand object

string

Unique, begins with 'brd_'

background_color

string

Valid hex code

color

string

Valid hex code

logo

string

Base64-encoded string for a PNG, GIF, JPEG, or SVG

logo_href

string

Valid URL, under 255 characters

string

Base64-encoded string for a PNG, GIF, JPEG, or SVG

ad_href

string

Valid URL, under 255 characters

name

string

The name associated with the User object

user_id

string

The ID of the User object

theme

string

The name of the theme template. Possible values:

theme1
theme2

Brand Object

{
  "id": "brd_aa3f5a1043ca46cf8e2e9b879c9a5895",
  "color": "#123456",
  "logo": "https://assets.easypost.com/assets/images/branding/easypost-primary-logo.7324aa54b64b34d6cd70ca5ba4d1842d.svg",
  "logo_href": "https://www.easypost.com",
  "name": "EasyPost",
  "ad": null,
  "ad_href": null,
  "object": "Brand",
  "user_id": "user_060ab38db3c04ffaa60f262e5781a9be",
  "background_color": "#123456",
  "theme": "theme1"
}

Update a Brand

To update a Brand, you need to specify the User.

Request Parameters

background_color

i.e. "#FFFFFF"

color

i.e. "#303F9F"

logo

i.e. "data:image/png;base64,iVBORw0KGgoAAAANSUhEUg..."

logo_href

i.e. "https://www.easypost.com"

i.e. "data:image/png;base64,iVBORw0KGgoAAAANSUhEUg..."

ad_href

i.e. "https://www.easypost.com"

theme

i.e. "theme2"

PATCH /users/:id/brand

1curl -X PATCH https://api.easypost.com/v2/users/user_.../brand \
2  -u "EASYPOST_API_KEY": \
3  -H 'Content-Type: application/json' \
4  -d '{
5    "brand": {
6      "background_color": "#FFFFFF",
7      "color": "#303F9F",
8      "logo": "data:image/png;base64,iVBORw0K...",
9      "logo_href": "https://easypost.com",
10      "ad": "null",
11      "ad_href": "null",
12      "theme": "theme1"
13    }
14  }'

Response

1{
2  "id": "brd_aa3f5a1043ca46cf8e2e9b879c9a5895",
3  "color": "#123456",
4  "logo": "https://assets.easypost.com/assets/images/branding/easypost-primary-logo.7324aa54b64b34d6cd70ca5ba4d1842d.svg",
5  "logo_href": "https://www.easypost.com",
6  "name": "EasyPost",
7  "ad": null,
8  "ad_href": null,
9  "object": "Brand",
10  "user_id": "user_060ab38db3c04ffaa60f262e5781a9be",
11  "background_color": "#123456",
12  "theme": "theme1"
13}