Update an audience

PATCH

/v1/audiences/{audience_id}

curl -X PATCH "https://us1.platform.bird.com/v1/audiences/{audience_id}" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Newsletter subscribers"
  }'

Updates an audience's name or description.

Parámetros

audience_id

string

Audience ID.

Cuerpo de la solicitud

name

string

Display name for the audience.

description

nullable string

Longer description of who this audience is. Set to null to clear.

Carga de respuesta

string

obligatorio

Audience ID.

name

string

obligatorio

Display name for the audience.

description

nullable string

Longer description of who this audience is.

type

string

obligatorio

How the audience's recipients are determined. static audiences have an explicit member list you manage via the API. dynamic and external are preview values and currently unavailable — creating an audience with either returns an error.

created_at

string

obligatorio

updated_at

string

obligatorio

curl -X PATCH "https://us1.platform.bird.com/v1/audiences/{audience_id}" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Newsletter subscribers"
  }'