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

SparkPost

Profile Requirements

To deliver a message to a recipient over SparkPost, Courier must be provided the recipient's email address. This value should be included in the recipient profile as email.

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

Overrride

You can use a provider override to replace what we send to SparkPost's Transmissions API. For example, you can add an attachment to your request:

{
  "event": "ABCDEFGHIJKLMNOPQRSTUVWXYZ",
  "recipient": "abc123",
  "profile": {
    "email": "[email protected]",
  },
  "override": {
    "sparkpost": {
      "body": {
        "content": {
          "attachments": [
            {
              "name": "billing.pdf",
              "type": "application/pdf",
              "data": "Q29uZ3JhdHVsYXRpb25zLCB5b3UgY2FuIGJhc2U2NCBkZWNvZGUh"
            }
          ]
        }
      }
    }
  }
}

Everything inside of override.sparkpost will replace what we send to SparkPost's Transmissions API. You can see all the available options by visiting SparkPost API docs.

Updated about a year ago


SparkPost


Suggested Edits are limited on API Reference Pages

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