Bulk create audiences
const url = 'https://dev-api.infiniteaudience.ai/v1/audiences/bulk-create';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"audiences":[{"name":"example","segment_refs":[{"segment_id":"example","role":"include"}],"segment_ids":["example"],"excluded_segment_ids":["example"],"set_logic":"union","record_count":1,"visibility":"org"}],"campaign_id":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://dev-api.infiniteaudience.ai/v1/audiences/bulk-create \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "audiences": [ { "name": "example", "segment_refs": [ { "segment_id": "example", "role": "include" } ], "segment_ids": [ "example" ], "excluded_segment_ids": [ "example" ], "set_logic": "union", "record_count": 1, "visibility": "org" } ], "campaign_id": "example" }'Create up to 25 composition audiences in a single request. Each item wraps one or more pre-existing segments (any subtype — filter, matched, similarity, or propensity) via segment_ids/excluded_segment_ids or segment_refs; it does not create new segments. To generate a new matched/similarity/ propensity segment and its wrapper audience in one call, use POST /v1/segments with create_audience: true instead. Optionally links all created audiences to a campaign via the audience_links sub-collection.
Requires ‘purchase’ scope.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”object
object
Explicit membership specs with role — preferred over segment_ids/excluded_segment_ids when present (takes precedence if both are supplied).
object
Visibility of the created audience. Defaults to ‘org’.
Link all created audiences to this campaign.
Responses
Section titled “Responses”Audiences created.
object
object
Active = ready for delivery; archived = soft-deleted via PATCH status:archived (excluded from list by default); expired = past 90-day TTL. Note: pending/failed statuses belong on segments, not audiences.
ID of the most recent delivery quote for this audience.
Total cost in cents from the most recent delivery quote.
ID of the audience this was forked from (null if not a fork).
Snapshot version of the parent audience at the time of forking.
ID of the campaign this audience is linked to, if any.
Total resolved records across all composed segments.
Records contributed by matched-subtype segments in this audience’s composition. Present only when the composition includes at least one included matched segment; null for pure-filter or non-matched compositions.
Records resolved to a known identity, for an audience created via the direct file-upload flow (POST /v1/match/file). Populated when that upload’s matching pipeline completes; null before then or for audiences not created that way — use matched_record_count for a composition-level matched count instead.
Rows in the originally uploaded identity file, for an audience created via POST /v1/match/file. Same population conditions as match_count.
Match_count / input_record_count, rounded to 4 decimal places. Null unless both match_count and input_record_count are present.
ISO date — 90-day hard expiry from creation
Org (default) — visible to all members of the org. private — visible only to the creating user.
Composition of segments that define this audience. Each entry specifies a segment and its role (include or exclude) in the set operation.
object
ID of the referenced segment.
Whether the segment’s records are included in or excluded from the audience.
Cache of include-role segment IDs (denormalized from segment_refs for query efficiency).
Cache of exclude-role segment IDs (denormalized from segment_refs for query efficiency).
Expanded summaries of the include-role segments, in segment_ids order. Populated on both list and single-GET responses. Best-effort — missing or deleted segment docs are skipped, so this array may be shorter than segment_ids.
Lightweight summary of a constituent segment, expanded server-side from the audience’s composition. Returned on both list and single-GET audience responses. subtype is the segment’s own subtype — use the first entry of segments (the primary included segment) to derive subtype-specific presentation for the audience.
object
Segment document ID.
Segment display name.
Cached record count of the segment. Null if never counted.
Subtype of the constituent segment.
Matched subtype only. Count of records in the uploaded identity file. Null otherwise.
Matched subtype only. Count of records successfully matched. Null otherwise.
Expanded summaries of the exclude-role segments, in excluded_segment_ids order. Same expansion semantics as segments.
Lightweight summary of a constituent segment, expanded server-side from the audience’s composition. Returned on both list and single-GET audience responses. subtype is the segment’s own subtype — use the first entry of segments (the primary included segment) to derive subtype-specific presentation for the audience.
object
Segment document ID.
Segment display name.
Cached record count of the segment. Null if never counted.
Subtype of the constituent segment.
Matched subtype only. Count of records in the uploaded identity file. Null otherwise.
Matched subtype only. Count of records successfully matched. Null otherwise.
How the include-role segments are combined: union = a record matches ANY included segment (OR); intersection = a record must match EVERY included segment (AND). Segments in excluded_segment_ids are always subtracted from that result (AND NOT), regardless of set_logic.
object
Example
{ "audiences": [ { "status": "active", "visibility": "org", "segment_refs": [ { "role": "include" } ], "segments": [ { "subtype": "filter" } ], "excluded_segments": [ { "subtype": "filter" } ], "set_logic": "union" } ]}Invalid request — malformed body, missing required attribute, or failed validation. See error and message for details.
object
Stable machine-readable error code (e.g. INVALID_STATUS_TRANSITION, BILLING_INSUFFICIENT_BALANCE). Always present.
Human-readable explanation of the error.
Alternate machine-readable code — present on some endpoints as an alias for error for backward compatibility.
Opaque support/debug identifier when available.
Examples
{ "error": "Bad Request", "code": "MISSING_SEGMENTS", "message": "segment_ids is required for filter audiences."}Missing or invalid Bearer token. Obtain one via POST /v1/auth/token. When a token was supplied but rejected, code distinguishes TOKEN_EXPIRED (the token’s lifetime has passed — request a new one via POST /v1/auth/token and retry) from TOKEN_INVALID (malformed or revoked — re-authenticate).
object
Stable machine-readable error code (e.g. INVALID_STATUS_TRANSITION, BILLING_INSUFFICIENT_BALANCE). Always present.
Human-readable explanation of the error.
Alternate machine-readable code — present on some endpoints as an alias for error for backward compatibility.
Opaque support/debug identifier when available.
Examples
{ "error": "Unauthorized: Missing or invalid Authorization header"}{ "error": "Unauthorized", "code": "TOKEN_EXPIRED", "message": "Your session has expired. Please sign in again."}Token is valid but lacks the required scope for this endpoint. Check the endpoint description for the required scope (discovery, purchase, or account).
object
Stable machine-readable error code (e.g. INVALID_STATUS_TRANSITION, BILLING_INSUFFICIENT_BALANCE). Always present.
Human-readable explanation of the error.
Alternate machine-readable code — present on some endpoints as an alias for error for backward compatibility.
Opaque support/debug identifier when available.
Examples
{ "error": "SCOPE_REQUIRED", "message": "This endpoint requires the purchase scope."}