Skip to content

Bulk hard-delete segments

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

Permanently delete up to 50 segments in one request — the bulk counterpart of DELETE /v1/segments/{id} (sets deleted: true, dropping each segment out of every referencing audience’s composition). Unlike the single-segment DELETE, there is no confirm_impact bypass here: a segment referenced by 1+ audiences is always skipped (never force-deleted) and reported back in skipped, since a bulk action has no per-segment confirmation UI to make an informed override decision. Delete the segment individually via DELETE /v1/segments/{id}?confirm_impact=true to force it. Best-effort per segment: not-found/already-deleted ids are reported in failed. Requires ‘purchase’ scope.

Media typeapplication/json
object
segment_ids
required

IDs of segments to delete (1-50).

Array<string>
>= 1 items <= 50 items
Examplegenerated
{
"segment_ids": [
"example"
]
}

Bulk delete processed. In-use segments and per-segment failures, if any, are listed in skipped/failed respectively.

Media typeapplication/json
object
deleted
required

Number of segments permanently deleted.

integer
skipped
required

Segments left untouched because they’re referenced by 1+ audiences.

Array<object>
object
id
required
string
audience_count
required
integer
campaign_count
required
integer
failed
required

Segments that could not be deleted (not found/already deleted).

Array<object>
object
id
required
string
error
required
string
Example
{
"deleted": 1,
"skipped": [
{
"id": "seg_in_use",
"audience_count": 2,
"campaign_count": 1
}
],
"failed": [
{
"id": "seg_missing",
"error": "Not found"
}
]
}

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."
}

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"
}

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."
}