Segments

Bulk update segments

Apply the same name and/or status change to up to 50 segments in one request. Only name and status are bulk-patchable — they are valid across all four subtypes. Composition and subtype-specific attributes (filters, filter_groups, column_mappings) are rejected with 400 INVALID_FIELD; use PATCH /v1/segments/{id} for those. Best-effort per segment: each segment is updated independently and failures (not found, invalid status transition) are reported per id in the failed array — successful updates are never rolled back. The single-PATCH status transition rule applies per segment: only archived segments can be restored to active. Requires 'creator' scope.

patch/v1/segments/bulk

Request

  • Base URL: https://api.infiniteaudience.ai
  • URL: https://api.infiniteaudience.ai/v1/segments/bulk
  • Auth: HTTP bearer

Request body

segment_idsstring[] required

IDs of segments to update (1-50).

namestring

New display name applied to every listed segment.

status'active' | 'archived'

New status applied to every listed segment. Only user-settable values are accepted; 'active' is only valid on segments currently archived (per-segment failure otherwise).

Response

Bulk update processed. Per-segment failures, if any, are listed in failed.

updatedinteger required

Number of segments successfully updated.

Changes

No recorded changes to this operation across all 1 revision of this API.