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

Profile Requirements

No profile data is required for Beamer.

Override

Overrides can be used to change the request body that Courier uses to send a push message. Overrides are useful when a field is not yet supported by Courier or you would like to override the value that Courier generates. You can override the following fields from Beamer’s postcreation object (documented here in Beamer's API docs).

{
  "filter": "",
  "filterUserId": "",
  "filterUrl": "",
  "sendPushNotification": "",
  "publish": "",
}

Below is an example of using the override to deliver a post to a specific known user id.

{
  "override": {
    "beamer": {
      "body": {
        "filterUserId": "YOUR USER ID",
        "sendPushNotification": "false",
        "publish": "true",
      }
    }
  }
}

Updated about a month ago


Beamer


Suggested Edits are limited on API Reference Pages

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