Create Audience
POST /v2/partner/audiences
Required scopes
partner:audiences:write
Tokens missing any required scope return 401 scope_missing.
See Auth & Scopes for issuance.
Operation
| Operation ID | createAudience |
| Tags | Audience |
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| — |
Request body
Required
object
| Field | Type | Description |
|---|---|---|
| name * | string | |
| source * | oneOf<object | object | object> | |
| expires_at | updated_at | RFC 3339 / ISO 8601 timestamp. |
Responses
202
Accepted
object
| Field | Type | Description |
|---|---|---|
| id * | id | UUID v4. |
| surface * | enum (3) | partneripaasbatch |
| operation * | enum (11) | Per 04-batch.md §3.1. Includes session-6 addition `incoming_webhooks.replay`.contacts.upsertaccounts.upsertengagement_events.backfillmessages.sendjourneys.enroll_cohortjourneys.bulk_cancelcohorts.materializecohorts.materialize_to_audienceobjectives.bulk_completewebhooks.bulk_replayincoming_webhooks.replay |
| status * | enum (6) | acceptedrunningsucceededpartially_failedfailedcancelled |
| source * | oneOf<object | object | object | object> | |
| created_at * | updated_at | RFC 3339 / ISO 8601 timestamp. |
| started_at | updated_at | RFC 3339 / ISO 8601 timestamp. |
| completed_at | updated_at | RFC 3339 / ISO 8601 timestamp. |
| progress * | object | |
| errors_url | string | |
| result_url | string | |
| idempotency_key * | string |
Example request
POST https://api.digitalonboarding.com/v2/partner/audiences
Authorization: Bearer <partner-token>
Content-Type: application/json
Idempotency-Key: <uuid-v4>
{ /* request body matching schema above */ }