Create a bulk job

Create a Bulk Job

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

Method: POST

Body Parameters

messageobjectrequired

+ Show Properties

Responses

status: 201 CREATED

jobIdstring

A unique identifier associated with the bulk job.

status: 400 Bad Request

messagestring

A message describing the error that occurred.

typestring

[invalid_request_error] The type of error that occurred.

Request Example

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();

Responses Example

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

{
  "message": "Error Message",
  "type": "invalid_request_error"
}

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