Courier

The Courier Developer Hub

Welcome to the Courier developer hub. You'll find comprehensive guides and documentation to help you start working with Courier as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    API Reference

Email Integrations

Courier supports a number of Email Providers. In order to send a notification using an Email Channel, the recipient profile must include an email address in the email property.

// Recipient Profile
{
  "email": "[email protected]"
}

Learn more about specific Email Integrations by selecting them on the left.

Can't find a provider? Shoot us a message using Intercom at the bottom of this page.

Email channel-level overrides

The email channel override allows you to set the subject, reply to, from, cc, and bcc email addresses, as well as the HTML and text via an override that will apply to all your email channels* within a template.

*Note: attachment overrides done at the channel level will only work with Mailgun and AWS SES currently. To add attachments to other providers, see the override section of the integration-specific doc.

Here is the override data structure for the email channel override:

{
  //rest of request
  "override": {
    "channel": {
      "email": {
        "attachments": [],
        "bcc": "",
        "cc": "",
        "from": "",
        "html": "",
        "replyTo": "",
        "subject": "",
        "text": "",
        "tracking": {
          "open": false
        }
      }
    }
  }
}

Brand override via API

overrides.brand uses same schema as https://docs.courier.com/reference/brands-api#createbrand

Brand elements that can be overridden:

  • logo
  • topbar color
  • brand colors

Here is the override data structure for the email channel override. In this example, the override is setting the logo image URL.

{
  "event": "CTJNNFP7NHMKMBPJFZX4P39ABSXR",
  "recipient": "{{ recipient.id  }}",
  "profile": {
    "email": "[email protected]"
  },
  "data": {
    "name": "Tony",
    "inviteLink": "https://courier.com/register?code=blah"
  },
  "override": {
    "brand": {
      "settings": {
        "email": {
          "header": {
          "logo": {
              "image": "https://www.courier.com/logo.png",
              "href": "https://www.courier.com"
            },
          "barColor": "ff5d5e"
          }
        }
      }
    }
  }
}

Updated 17 days ago


What's Next

Follow this guide to get started sending email using SendGrid.

Setup Email using SendGrid

Email Integrations


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.