Update a brand

PUThttps://api.courier.com/brands/:brand_id

Replace an existing brand with the supplied values.

PATH PARAMS

brand_idstringrequired

A unique identifier associated with the brand you wish to update.

BODY PARAM

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

falsetrue

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

curl --request PUT \
     --url https://api.courier.com/brands/C8CPX6HQZ5M7Q5KAMW5CXC4N98DH \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --data '
{
  "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"
        }
      }
    }
  }
}
'

Node.js

// Dependencies to install:
// $ npm install node-fetch --save

const fetch = require('node-fetch');

const options = {
  method: 'PUT',
  headers: {
    Accept: 'application/json',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "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"
          }
        }
      }
    }
  })
};

fetch('https://api.courier.com/brands/C8CPX6HQZ5M7Q5KAMW5CXC4N98DH', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.courier.com/brands/C8CPX6HQZ5M7Q5KAMW5CXC4N98DH")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Accept"] = 'application/json'
request["Content-Type"] = 'application/json'
request.body = "{\"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 = http.request(request)
puts response.read_body

Python

# Dependencies to install:
# $ python -m pip install requests

import requests

url = "https://api.courier.com/brands/C8CPX6HQZ5M7Q5KAMW5CXC4N98DH"

payload = {
  "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"
        }
      }
    }
  }
}
headers = {
  "Accept": "application/json",
  "Content-Type": "application/json"
}

response = requests.request("PUT", url, json=payload, headers=headers)

print(response.text)

Go

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://api.courier.com/brands/C8CPX6HQZ5M7Q5KAMW5CXC4N98DH"

  payload := strings.NewReader("{\"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\"}}}}}")

  req, _ := http.NewRequest("PUT", url, payload)

  req.Header.Add("Accept", "application/json")
  req.Header.Add("Content-Type", "application/json")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

PHP

<?php
// Dependencies to install:
// $ composer require guzzlehttp/guzzle

require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.courier.com/brands/C8CPX6HQZ5M7Q5KAMW5CXC4N98DH', [
  'body' => '{"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"}}}}}',
  'headers' => [
    'Accept' => 'application/json',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();

Response Example

200 Successfully replaced400 Bad Request404 Not Found

{
  "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: PUT

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

Body: ​

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