Skip to main content
PUT
/
audiences
/
{audience_id}
JavaScript
import Courier from '@trycourier/courier';

const client = new Courier({
  apiKey: 'My API Key',
});

const audience = await client.audiences.update('audience_id');

console.log(audience.audience);
{
  "audience": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "filter": {
      "operator": "ENDS_WITH",
      "value": "<string>",
      "path": "<string>"
    },
    "created_at": "<string>",
    "updated_at": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

audience_id
string
required

A unique identifier representing the audience id

Body

application/json
name
string | null

The name of the audience

description
string | null

A description of the audience

filter
object

A single filter to use for filtering

Response

200 - application/json
audience
object
required