Skip to main content
POST
/
brands
Create a new brand
curl --request POST \
  --url https://api.courier.com/brands \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "<string>",
  "name": "<string>",
  "settings": {
    "colors": {
      "primary": "<string>",
      "secondary": "<string>"
    },
    "email": {
      "templateOverride": {
        "backgroundColor": "<string>",
        "blocksBackgroundColor": "<string>",
        "enabled": true,
        "footer": "<string>",
        "head": "<string>",
        "header": "<string>",
        "width": "<string>",
        "mjml": {
          "backgroundColor": "<string>",
          "blocksBackgroundColor": "<string>",
          "enabled": true,
          "footer": "<string>",
          "head": "<string>",
          "header": "<string>",
          "width": "<string>"
        },
        "footerBackgroundColor": "<string>",
        "footerFullWidth": true
      },
      "head": {
        "inheritDefault": true,
        "content": "<string>"
      },
      "footer": {
        "content": "<string>",
        "inheritDefault": true
      },
      "header": {
        "inheritDefault": true,
        "barColor": "<string>",
        "logo": {
          "href": "<string>",
          "image": "<string>"
        }
      }
    },
    "inapp": {
      "borderRadius": "<string>",
      "disableMessageIcon": true,
      "fontFamily": "<string>",
      "placement": "top",
      "widgetBackground": {
        "topColor": "<string>",
        "bottomColor": "<string>"
      },
      "colors": {
        "primary": "<string>",
        "secondary": "<string>"
      },
      "icons": {
        "bell": "<string>",
        "message": "<string>"
      }
    }
  },
  "snippets": {
    "items": [
      {
        "name": "<string>",
        "value": "<string>"
      }
    ]
  }
}'
{
  "id": "<string>",
  "name": "<string>",
  "published": 123,
  "created": 123,
  "updated": 123,
  "settings": {
    "colors": {
      "primary": "<string>",
      "secondary": "<string>"
    },
    "email": {
      "templateOverride": {
        "backgroundColor": "<string>",
        "blocksBackgroundColor": "<string>",
        "enabled": true,
        "footer": "<string>",
        "head": "<string>",
        "header": "<string>",
        "width": "<string>",
        "mjml": {
          "backgroundColor": "<string>",
          "blocksBackgroundColor": "<string>",
          "enabled": true,
          "footer": "<string>",
          "head": "<string>",
          "header": "<string>",
          "width": "<string>"
        },
        "footerBackgroundColor": "<string>",
        "footerFullWidth": true
      },
      "head": {
        "inheritDefault": true,
        "content": "<string>"
      },
      "footer": {
        "content": "<string>",
        "inheritDefault": true
      },
      "header": {
        "inheritDefault": true,
        "barColor": "<string>",
        "logo": {
          "href": "<string>",
          "image": "<string>"
        }
      }
    },
    "inapp": {
      "borderRadius": "<string>",
      "disableMessageIcon": true,
      "fontFamily": "<string>",
      "placement": "top",
      "widgetBackground": {
        "topColor": "<string>",
        "bottomColor": "<string>"
      },
      "colors": {
        "primary": "<string>",
        "secondary": "<string>"
      },
      "icons": {
        "bell": "<string>",
        "message": "<string>"
      }
    }
  },
  "snippets": {
    "items": [
      {
        "name": "<string>",
        "value": "<string>"
      }
    ]
  },
  "version": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required
id
string | null
settings
object
snippets
object

Response

id
string
required
name
string
required
created
integer
required
updated
integer
required
published
integer | null
settings
object
snippets
object
version
string | null