Create a bulk job

POSThttps://api.courier.com/bulk

Create a Bulk Job

BODY PARAM

messageobjectrequired

Message definition for the job

eventstring

A unique identifier that can be mapped to an individual Notification. This could be the "Notification ID” on Notification detail pages (see the Notifications page in the Courier app) or a custom string mapped to the event in settings.

brandstring

A unique identifier that represents the brand that should be used for rendering the notification.

datajson

An object that includes any data you want to pass to a message template. The data will populate the corresponding template variables.

{"name":"Jane Doe","age":27}

overridejson

An object that is merged into the request sent by Courier to the provider to override properties or to gain access to features in the provider API that are not natively supported by Courier.

templatestring

A notification template id or event mapping from Courier Studio. Either this or content must be specified.

brand_idstring

A unique identifier that represents the brand that should be used for rendering the notification. Note that a brand_id will only be applied to a Template message.

routingobject

Allows you to customize which channel(s) Courier will potentially deliver the message. If no routing key is specified, Courier will use the default routing configured in the Courier Studio UI.

methodstring

The method for selecting channels to send the message with. Value can be either 'single' or 'all'. If not provided will default to 'single'

allsingle

channelsarray

An array of valid channel identifiers (like email, push, sms, etc.) and additional routing nodes.

channelsrecord

A map of valid channel identifiers (e.g. email, sms, etc.) to channel configuration objects whose properties are below. If you don't specify 'channels', Courier will use the default configuration for each channel as specified in the Courier Studio UI.

providersrecord

The providers object is a map of valid provider identifiers (e.g. twilio, slack, etc.) to provider configuration objects. If you don't specify providers, Courier will use the default configuration for each provider as specified in the Courier Studio UI.

metadataobject

eventstring

An arbitrary string to tracks the event that generated this request (e.g. 'signup').

tagsarray

An array of up to 9 tags you wish to associate with this request (and corresponding messages) for later analysis. Individual tags cannot be more than 30 characters in length.

trace_idstring

A unique ID used to correlate this request to processing on your servers. Courier does not verify the uniqueness of this ID.

utmobject

Identify the campaign that refers traffic to a specific website, and attributes the browser's website session.

campaignstring

contentstring

mediumstring

sourcestring

termstring

Responses

AUTH TOKEN

cURL

curl --request POST \
     --url https://api.courier.com/bulk \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --data '
{
  "message": {
    "event": "EXAMPLE_NOTIFICATION",
    "brand": "W50NC77P524K14M5300PGPEK4JMJ",
    "data": {
      "name": "Jane Doe",
      "age": 27
    }
  }
}
'

Node.js

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

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

const options = {
  method: 'POST',
  headers: {
    Accept: 'application/json',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "message": {
      "event": "EXAMPLE_NOTIFICATION",
      "brand": "W50NC77P524K14M5300PGPEK4JMJ",
      "data": {
        "name": "Jane Doe",
        "age": 27
      }
    }
  })
};

fetch('https://api.courier.com/bulk', 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/bulk")

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

request = Net::HTTP::Post.new(url)
request["Accept"] = 'application/json'
request["Content-Type"] = 'application/json'
request.body = "{\"message\":{\"event\":\"EXAMPLE_NOTIFICATION\",\"brand\":\"W50NC77P524K14M5300PGPEK4JMJ\",\"data\":{\"name\":\"Jane Doe\",\"age\":27}}}"

response = http.request(request)
puts response.read_body

Python

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

import requests

url = "https://api.courier.com/bulk"

payload = {
  "message": {
    "event": "EXAMPLE_NOTIFICATION",
    "brand": "W50NC77P524K14M5300PGPEK4JMJ",
    "data": {
      "name": "Jane Doe",
      "age": 27
    }
  }
}
headers = {
  "Accept": "application/json",
  "Content-Type": "application/json"
}

response = requests.request("POST", 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/bulk"

  payload := strings.NewReader("{\"message\":{\"event\":\"EXAMPLE_NOTIFICATION\",\"brand\":\"W50NC77P524K14M5300PGPEK4JMJ\",\"data\":{\"name\":\"Jane Doe\",\"age\":27}}}")

  req, _ := http.NewRequest("POST", 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('POST', 'https://api.courier.com/bulk', [
  'body' => '{"message":{"event":"EXAMPLE_NOTIFICATION","brand":"W50NC77P524K14M5300PGPEK4JMJ","data":{"name":"Jane Doe","age":27}}}',
  'headers' => [
    'Accept' => 'application/json',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();

Response Example

201 CREATED400 Bad Request

{
  "jobId": "1-61e9dd53-b5bb6c863b7ffbe83ad4b28d"
}

Example

Method: POST

URL: https://api.courier.com/bulk

Body: ​

{
    "message": {
        "event": "abcdefgh12345678",
        "brand": "W50NC77P524K14M5300PGPEK4JMJ",
        "data": {
            "name": "Jane Doe",
            "age": 27
        },
        "routing": {
            "method": "single"
        },
        "template": "NOTIFICATION_TEMPLATE"
    }
}