Segments

Permanently remove a segment

Removes the segment from every read surface: GET /v1/segments/{id} returns 404 afterward, and GET /v1/segments always excludes it (there is no override, unlike archived segments). There is no restore endpoint — this is a one-way operation from the API's perspective, even though the underlying record is retained internally rather than hard-deleted.

Effect on audiences: unlike archiving, deleting a segment that's referenced by one or more audiences changes those audiences' composition — the segment is dropped from their resolved segment list and record count. This is the reason for the impact check below; archiving has no such check because it never has this effect.

Impact check: if the segment is referenced by one or more active audiences, the server returns a 409 with audience_count, campaign_count, and an audiences list. Re-submit with ?confirm_impact=true to proceed anyway.

Not idempotent: calling this twice returns 404 on the second call, since the segment is already excluded from lookup after the first delete. No credits are debited. Requires 'creator' scope.

delete/v1/segments/{id}

Request

  • Base URL: https://api.infiniteaudience.ai
  • URL: https://api.infiniteaudience.ai/v1/segments/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Query parameters

confirm_impactboolean

Pass true to delete a segment that is referenced by active audiences. Omitting this parameter on an in-use segment returns a 409 with impact details.

Response

Segment successfully deleted (archived).

Changes

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