Add users

Ingest user data into a Bulk Job

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

Method: POST

PATH PARAMS

job_idstringrequired

A unique identifier representing the bulk job

BODY PARAMS

usersarray

User data ingestion for the job

+ Show Properties

RESPONSES:

status: 200 OK

errorsarray

Errors occurred during job data ingestion

totalnumber

Total count of users that have been successfully ingested

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/1-61e9dd53-b5bb6c863b7ffbe83ad4b28d \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --data '
{
  "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"
      }
    }
  ]
}
'

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({
    "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"
        }
      }
    ]
  })
};

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'
request["Content-Type"] = 'application/json'
request.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\"}}]}"

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"

payload = {
  "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"
      }
    }
  ]
}
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/1-61e9dd53-b5bb6c863b7ffbe83ad4b28d"

  payload := strings.NewReader("{\"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\"}}]}")

  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/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"}}]}',
  'headers' => [
    'Accept' => 'application/json',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();

Responses Example

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

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

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