Add users

POSThttps://api.courier.com/bulk/:job_id

Ingest user data into a Bulk Job

PATH PARAMS

job_idstringrequired

A unique identifier representing the bulk job

BODY PARAM

usersarrayrequired

User data ingestion for the job

Responses

AUTH TOKEN

cURL

curl --request POST \
     --url https://api.courier.com/bulk/1-61e9dd53-b5bb6c863b7ffbe83ad4b28d \
     --header 'Accept: application/json' 

Node.js

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

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

const options = {
  method: 'POST',
  headers: {
    Accept: 'application/json'
  },
};

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

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

request = Net::HTTP::Post.new(url)
request["Accept"] = 'application/json'

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/1-61e9dd53-b5bb6c863b7ffbe83ad4b28d"

headers = {
  "Accept": "application/json"
}

response = requests.request("POST", url, headers=headers)

print(response.text)

Go

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://api.courier.com/bulk/1-61e9dd53-b5bb6c863b7ffbe83ad4b28d"

  req, _ := http.NewRequest("POST", url, payload)

  req.Header.Add("Accept", "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/1-61e9dd53-b5bb6c863b7ffbe83ad4b28d', [
  'headers' => [
    'Accept' => 'application/json',
  ],
]);

echo $response->getBody();

Response Example

200 OK400 Bad Request

{
  "errors": [
    {
      "error": "Duplicate user",
      "user": {
        "email": "u1@courier.com",
        "user_id": "u1",
        "data": {
          "recipientName": "Foo"
        }
      }
    }
  ]
}

Example

Method: POST

URL: https://api.courier.com/bulk/1-61e9dd53-b5bb6c863b7ffbe83ad4b28d

Body: ​

{
    "users": [
        {
            "recipient": "8ec8c99a-c5f7-455b-9f60-8222b8a27056",
            "profile": {
                "phone_number": "2025550125",
                "email": "hello@example.com"
            },
            "data": {
                "name": "Jane Doe",
                "age": 27
            },
            "to": {
                "email": "tejas@courier.com"
            }
        }
    ]
}