POST /send/list

POSThttps://api.courier.com/send/list

Send a notification to list(s) subscribers

BODY PARAM

liststringrequired

The list id intended to send.

eventstringrequired

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.

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.

preferencesjson

An object that includes runtime preferences. These take precedence over those set at the user level

Responses

AUTH TOKEN

curl --request POST \
     --url https://api.courier.com/send/list \
     --header 'Accept: application/json' 

// 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/send/list', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.courier.com/send/list")

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

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

import requests

url = "https://api.courier.com/send/list"

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

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

print(response.text)

package main

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

func main() {

  url := "https://api.courier.com/send/list"

  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
// Dependencies to install:
// $ composer require guzzlehttp/guzzle

require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.courier.com/send/list', [
  'headers' => [
    'Accept' => 'application/json',
  ],
]);

echo $response->getBody();

Response Example

{
  "messageId": "1-5e2b2615-05efbb3acab9172f88dd3f6f"
}