Run an Ad-hoc Automation

Invoke an ad hoc automation run. This endpoint accepts a JSON payload with a series of automation steps. For information about what steps are available, checkout the ad hoc automation guide here.

URL: https://api.courier.com/automations/invoke

Method: POST

Body Parameters

automationobjectrequired

+ Show Properties

brandstring

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

templatestring

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.

recipientstring

A unique identifier associated with the recipient of the delivered message.

datajson

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

profilejson

An object that includes any key-value pairs required by your chosen Integrations (see our Provider Documentation for the requirements for each Integration.) If profile information is included in the request and that information already exists in the profile for the recipientId, that information will be merged.

Response

status: 200 OK

runIdstring

A unique identifier associated with the automation run.

Request Example

cURL

curl --request POST \
     --url https://api.courier.com/automations/invoke \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --data '
{
  "brand": "W50NC77P524K14M5300PGPEK4JMJ",
  "template": "EXAMPLE_NOTIFICATION",
  "recipient": "8ec8c99a-c5f7-455b-9f60-8222b8a27056",
  "data": {
    "name": "Jane Doe",
    "age": 27
  },
  "profile": {
    "phone_number": "2025550125",
    "email": "hello@example.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({
    "brand": "W50NC77P524K14M5300PGPEK4JMJ",
    "template": "EXAMPLE_NOTIFICATION",
    "recipient": "8ec8c99a-c5f7-455b-9f60-8222b8a27056",
    "data": {
      "name": "Jane Doe",
      "age": 27
    },
    "profile": {
      "phone_number": "2025550125",
      "email": "hello@example.com"
    }
  })
};

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

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 = "{\"brand\":\"W50NC77P524K14M5300PGPEK4JMJ\",\"template\":\"EXAMPLE_NOTIFICATION\",\"recipient\":\"8ec8c99a-c5f7-455b-9f60-8222b8a27056\",\"data\":{\"name\":\"Jane Doe\",\"age\":27},\"profile\":{\"phone_number\":\"2025550125\",\"email\":\"hello@example.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/automations/invoke"

payload = {
  "brand": "W50NC77P524K14M5300PGPEK4JMJ",
  "template": "EXAMPLE_NOTIFICATION",
  "recipient": "8ec8c99a-c5f7-455b-9f60-8222b8a27056",
  "data": {
    "name": "Jane Doe",
    "age": 27
  },
  "profile": {
    "phone_number": "2025550125",
    "email": "hello@example.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/automations/invoke"

  payload := strings.NewReader("{\"brand\":\"W50NC77P524K14M5300PGPEK4JMJ\",\"template\":\"EXAMPLE_NOTIFICATION\",\"recipient\":\"8ec8c99a-c5f7-455b-9f60-8222b8a27056\",\"data\":{\"name\":\"Jane Doe\",\"age\":27},\"profile\":{\"phone_number\":\"2025550125\",\"email\":\"hello@example.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/automations/invoke', [
  'body' => '{"brand":"W50NC77P524K14M5300PGPEK4JMJ","template":"EXAMPLE_NOTIFICATION","recipient":"8ec8c99a-c5f7-455b-9f60-8222b8a27056","data":{"name":"Jane Doe","age":27},"profile":{"phone_number":"2025550125","email":"hello@example.com"}}',
  'headers' => [
    'Accept' => 'application/json',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();

Responses Example

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

Example

Method: POST

URL: https://api.courier.com/automations/invoke

Body: ​

{
  "automation": {
    "steps": [
      {
        "action": "delay",
        "duration": "2 minutes"
      }
    ],
    "cancelation_token": "abcdefgh12345678"
  },
  "brand": "W50NC77P524K14M5300PGPEK4JMJ",
  "template": "S6CME56DCCM6DVQA7CVZR1MTPFPA",
  "recipient": "8ec8c99a-c5f7-455b-9f60-8222b8a27056",
  "data": {
    "name": "Jane Doe",
    "age": 27
  },
  "profile": {
    "phone_number": "2025550125",
    "email": "hello@example.com"
  }
}