email-audiences

Update an audience

Updates an audience's name or description. Omitted fields are left unchanged; set description to null to clear it.

patch/v1/audiences/{audience_id}

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/audiences/{audience_id}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Path parameters

audience_idstring required
Example:adn_01krdgeqcxet5s7t44vh8rt9mg

ID of the audience to update.

Headers

Idempotency-Keystring

Client-supplied key. On operations supporting request deduplication, a retained response is replayed for duplicate requests with the same key within the idempotency window (3 hours by default). This protection requires a workspace, organization, or staff-account scope. User-only and unscoped unauthenticated operations, streams, and operations with a separate replay contract do not use this response replay.

On a supported operation, if idempotency protection is unavailable before execution, the API returns 503 IdempotencyUnavailable (E01033) without executing this attempt. Retry with backoff using the same key and request. An operation that takes effect before its response is retained can still execute again on retry.

Two distinct 409 errors signal misuse:

  • request_in_progress (E01004): The same key is currently being processed by a concurrent request. Wait briefly and retry. The lock expires within 30 seconds.
  • idempotency_key_reuse (E01005): The same key has already completed against a different request body or method. Generate a new key.

Recommended key format is <event-type>/<entity-id> (for example welcome-user/usr_abc123).

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Request body

namestring

New display name for the audience. Omit to keep the current name. The name cannot be cleared, and a whitespace-only value returns a validation error.

descriptionstring nullable

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

Example request

{
  "name": "Newsletter subscribers"
}

Response

The updated audience.

idstring required
namestring required

Display name for the audience.

descriptionstring nullable

Longer description of who this audience is.

type'static' required

How the audience's recipients are determined. static is an explicit member list you manage by adding and removing contacts.

created_atstring date-time required
updated_atstring date-time required

Example response

{
  "id": "adn_01krdgeqcxet5s7t44vh8rt9mg",
  "name": "Newsletter subscribers",
  "created_at": "2026-05-20T09:14:52Z",
  "updated_at": "2026-05-25T16:42:01Z"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.