Update an audience

Creates or updates audience.

URL: https://api.courier.com/audiences/:audience_id

Method: PUT

Path Parameters

audience_idstringrequired

A unique identifier representing the audience id

Body Parameters

idstring

A unique identifier representing the audience_id

namestring

The name of the audience

descriptionstring

A description of the audience

filteroneOf

+ Show Properties

Responses

status: 200 OK

audienceobject

+ Show Properties

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 PUT \
     --url https://api.courier.com/audiences/my-favorite-developer-audience \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --data '
{
  "id": "developer-audience",
  "name": "Developer Audience",
  "description": "Audience for developers",
  "filter": {
    "operator": "EQ",
    "value": "engineer",
    "path": "title"
  }
}
'

Node.js

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

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

const options = {
  method: 'PUT',
  headers: {
    Accept: 'application/json',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "id": "developer-audience",
    "name": "Developer Audience",
    "description": "Audience for developers",
    "filter": {
      "operator": "EQ",
      "value": "engineer",
      "path": "title"
    }
  })
};

fetch('https://api.courier.com/audiences/my-favorite-developer-audience', 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/audiences/my-favorite-developer-audience")

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

request = Net::HTTP::Put.new(url)
request["Accept"] = 'application/json'
request["Content-Type"] = 'application/json'
request.body = "{\"id\":\"developer-audience\",\"name\":\"Developer Audience\",\"description\":\"Audience for developers\",\"filter\":{\"operator\":\"EQ\",\"value\":\"engineer\",\"path\":\"title\"}}"

response = http.request(request)
puts response.read_body

Python

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

import requests

url = "https://api.courier.com/audiences/my-favorite-developer-audience"

payload = {
  "id": "developer-audience",
  "name": "Developer Audience",
  "description": "Audience for developers",
  "filter": {
    "operator": "EQ",
    "value": "engineer",
    "path": "title"
  }
}
headers = {
  "Accept": "application/json",
  "Content-Type": "application/json"
}

response = requests.request("PUT", 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/audiences/my-favorite-developer-audience"

  payload := strings.NewReader("{\"id\":\"developer-audience\",\"name\":\"Developer Audience\",\"description\":\"Audience for developers\",\"filter\":{\"operator\":\"EQ\",\"value\":\"engineer\",\"path\":\"title\"}}")

  req, _ := http.NewRequest("PUT", 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('PUT', 'https://api.courier.com/audiences/my-favorite-developer-audience', [
  'body' => '{"id":"developer-audience","name":"Developer Audience","description":"Audience for developers","filter":{"operator":"EQ","value":"engineer","path":"title"}}',
  'headers' => [
    'Accept' => 'application/json',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();

Responses Example

{
  "audience": {
    "id": "developer-audience",
    "name": "Developer Audience",
    "description": "Audience for developers",
    "created_at": "2023-08-23T18:40:59.143Z",
    "updated_at": "2023-08-23T18:45:26.199Z",
    "filter": {
      "operator": "EQ",
      "value": "engineer",
      "path": "title"
    }
  }
}

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

Example of an OR operator

{
  "audience": {
    "id": "abcdefgh12345678",
    "name": "Product Team",
    "description": "Members of the product team, including both engineers and product managers.",
    "filter": {
      "Multiple Filters": {
        "operator": "OR",
        "filters": [
          {
            "operator": "EQ",
            "value": "engineer",
            "path": "title"
          },
          {
            "operator": "EQ",
            "value": "product manager",
            "path": "title"
          }
        ]
      }
    }
  }
}

Example of an AND operator

JSON

{
  "audience": {
    "id": "abcdefgh12345678",
    "name": "Developers from San Francisco",
    "filter": {
      "operator": "AND",
      "filters": [
        {
          "path": "location",
          "operator": "EQ",
          "value": "San Francisco"
        },
        {
          "path": "job_title",
          "operator": "EQ",
          "value": "Developer"
        }
      ]
    }
  }
}