Bulk archive segments

DELETE

/v1/segments/bulk

curl --request DELETE \
  --url https://dev-api.infiniteaudience.ai/v1/segments/bulk \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "segment_ids": [ "example" ] }'

• Development API Server

Archive up to 50 segments in one request by setting status: archived. Deliberately DIVERGES from DELETE /v1/segments/{id}: the single-segment DELETE permanently removes the segment (sets deleted: true behind a SEGMENT_IN_USE impact gate, dropping it out of every referencing audience’s composition), while bulk archive only changes status — archived segments remain fully resolvable by audiences that reference them, so composition integrity is preserved and no impact gate is needed. Fully reversible via PATCH {status: active} (single or bulk). Best-effort per segment: not-found/deleted ids are reported in the failed array; already-archived segments count as success (idempotent). Requires ‘purchase’ scope.

Authorizations

• bearerAuth

Request Body^required

Media typeapplication/json

object

segment_ids

required

IDs of segments to archive (1-50).

Array<string>

>= 1 items <= 50 items

Example^generated

{
  "segment_ids": [
    "example"
  ]
}

Responses

200

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

Media typeapplication/json

object

archived

required

Number of segments now archived (includes already-archived segments, which are idempotent successes).

integer

failed

required

Segments that could not be archived.

Array<object>

object

id

required

string

error

required

string

Example

{
  "archived": 3,
  "failed": [
    {
      "id": "seg_missing",
      "error": "Not found"
    }
  ]
}

400

Invalid request — malformed body, missing required attribute, or failed validation. See error and message for details.

Media typeapplication/json

object

error

required

Stable machine-readable error code (e.g. INVALID_STATUS_TRANSITION, BILLING_INSUFFICIENT_BALANCE). Always present.

string

message

Human-readable explanation of the error.

string

code

Alternate machine-readable code — present on some endpoints as an alias for error for backward compatibility.

string

request_id

Opaque support/debug identifier when available.

string

key

additional properties

any

Examples

Examplevalidation_error

{
  "error": "Bad Request",
  "code": "MISSING_SEGMENTS",
  "message": "segment_ids is required for filter audiences."
}

401

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).

Media typeapplication/json

object

error

required

Stable machine-readable error code (e.g. INVALID_STATUS_TRANSITION, BILLING_INSUFFICIENT_BALANCE). Always present.

string

message

Human-readable explanation of the error.

string

code

Alternate machine-readable code — present on some endpoints as an alias for error for backward compatibility.

string

request_id

Opaque support/debug identifier when available.

string

key

additional properties

any

Examples

{
  "error": "Unauthorized: Missing or invalid Authorization header"
}

{
  "error": "Unauthorized",
  "code": "TOKEN_EXPIRED",
  "message": "Your session has expired. Please sign in again."
}

403

Token is valid but lacks the required scope for this endpoint. Check the endpoint description for the required scope (discovery, purchase, or account).

Media typeapplication/json

object

error

required

Stable machine-readable error code (e.g. INVALID_STATUS_TRANSITION, BILLING_INSUFFICIENT_BALANCE). Always present.

string

message

Human-readable explanation of the error.

string

code

Alternate machine-readable code — present on some endpoints as an alias for error for backward compatibility.

string

request_id

Opaque support/debug identifier when available.

string

key

additional properties

any

Examples

Examplemissing_scope

{
  "error": "SCOPE_REQUIRED",
  "message": "This endpoint requires the purchase scope."
}