Update Audience

PATCH /v2/partner/audiences/{id}

Required scopes

partner:audiences:write

Tokens missing any required scope return 401 scope_missing. See Auth & Scopes for issuance.

Operation

Operation ID updateAudience
Tags Audience

Parameters

Name In Type Description
id * path id

Request body

Required

object
FieldTypeDescription
namestring
expires_atupdated_atRFC 3339 / ISO 8601 timestamp.

Responses

200
OK
object

Session-6 addition per `01-partner-api.md` §3.3.

FieldTypeDescription
id *idUUID v4.
type *enum (1)
audience
team_id *idUUID v4.
name *string
source *source
total_contacts *integer
expires_atupdated_atRFC 3339 / ISO 8601 timestamp.
is_archived *boolean
archived_atupdated_atRFC 3339 / ISO 8601 timestamp.
batch_id *idUUID v4.
predicate_hashstring
materialized_at *updated_atRFC 3339 / ISO 8601 timestamp.
inserted_at *updated_atRFC 3339 / ISO 8601 timestamp.
updated_at *updated_atRFC 3339 / ISO 8601 timestamp.

Example request

PATCH https://api.digitalonboarding.com/v2/partner/audiences/{id}
Authorization: Bearer <partner-token>
Content-Type: application/json
Idempotency-Key: <uuid-v4>

{ /* request body matching schema above */ }