Skip to main content

Create a brand

POSThttps://api.courier.com/brands
Create a new brand
BODY PARAM
idstring
Brand Identifier
namestringrequired
Brand name
settingsobjectrequired
colorsobject
Brand colors
primarystring
Primary brand color
secondarystring
Secondary brand color
tertiarystring
Tertiary brand color
inappobject
Contains brand settings for inapp (inbox and toast)
disableMessageIconboolean
Signifies weather the 'Powered by Courier' footer is active or not
placementstring
Describes the placement of the inbox relative to the inbox. (bottom | left | right)
preferencesobject
Settings relevant to viewing and updating the preferences section of the Inbox. See: https://www.courier.com/docs/courier-preferences/
templateIdsarray
List of preference template ids
emailobject
Contains brand settings for emails
footerobject
Contains brand settings for the email footer
markdownstring
Markdown formatted content that will be rendered in the email footer
socialobject
facebookobject
urlstring
URL of Facebook Presence
instagramobject
urlstring
URL of Instagram Presence
linkedinobject
urlstring
URL of LinkedIn Presence
mediumobject
urlstring
URL of Medium Presence
twitterobject
urlstring
URL of Twitter Presence
headerobject
Contains brand settings for the email header
barColorstring
The color email header bar
logoobject
hrefstring
A URL that the logo, when clicked on, will link to.
imagestring
A URL pointing to the logo image
snippetsobject
itemsarray
Brand colors
Responses
AUTH TOKEN
curl --request POST \
--url https://api.courier.com/brands \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '
{
"id": "C8CPX6HQZ5M7Q5KAMW5CXC4N98DH",
"name": "Example Brand Name",
"settings": {
"colors": {
"primary": "#9D3789",
"secondary": "#9D3789",
"tertiary": "#9D3789"
},
"email": {
"footer": {
"markdown": "**Bold** and _italic_ with a [link](https://www.courier.com)",
"social": {
"facebook": {
"url": "https://www.facebook.com/example"
},
"instagram": {
"url": "https://www.instagram.com/example"
},
"linkedin": {
"url": "https://www.linkedin.com/example"
},
"medium": {
"url": "https://www.medium.com/example"
},
"twitter": {
"url": "https://www.twitter.com/example"
}
}
},
"header": {
"barColor": "#9D3789",
"logo": {
"href": "https://www.courier.com",
"image": "https://www.courier.com/logo.png"
}
}
}
}
}
'
Response Example
{
"created": 1591753605265,
"id": "C8CPX6HQZ5M7Q5KAMW5CXC4N98DH",
"name": "Example Brand Name",
"published": 1591753605265,
"settings": {
"colors": {
"primary": "#9D3789",
"secondary": "#9D3789",
"tertiary": "#9D3789"
},
"email": {
"footer": {
"markdown": "**Bold** and _italic_ with a [link](https://www.courier.com)",
"social": {
"facebook": {
"url": "https://www.facebook.com/example"
},
"instagram": {
"url": "https://www.instagram.com/example"
},
"linkedin": {
"url": "https://www.linkedin.com/example"
},
"medium": {
"url": "https://www.medium.com/example"
},
"twitter": {
"url": "https://www.twitter.com/example"
}
}
},
"header": {
"barColor": "#9D3789",
"logo": {
"href": "https://www.courier.com",
"image": "https://www.courier.com/logo.png"
}
}
}
},
"updated": 1591753605265,
"version": "2020-06-19T18:51:36.083Z"
}

Example

Method: POST

URL: https://api.courier.com/brands

Body: ​

{
"id": "C8CPX6HQZ5M7Q5KAMW5CXC4N98DH",
"name": "Example Brand Name",
"settings": {
"colors": {
"primary": "#9D3789",
"secondary": "#9D3789",
"tertiary": "#9D3789"
},
"email": {
"footer": {
"markdown": "**Bold** and _italic_ with a [link](https://www.courier.com)",
"social": {
"facebook": {
"url": "https://www.facebook.com/example"
},
"instagram": {
"url": "https://www.instagram.com/example"
},
"linkedin": {
"url": "https://www.linkedin.com/example"
},
"medium": {
"url": "https://www.medium.com/example"
},
"twitter": {
"url": "https://www.twitter.com/example"
}
}
},
"header": {
"barColor": "#9D3789",
"logo": {
"href": "https://www.courier.com",
"image": "https://www.courier.com/logo.png"
}
}
}
}
}