Delete a segment

Delete a segment

DELETE/api/v1/segments/{id}

scope contacts:write

Deletes the segment. The contacts in it are not touched. A segment that an assistant trigger is aimed at cannot be deleted — the answer is 409 conflict with reason: "segment_in_use"; repoint or delete the trigger first.

Path parameters

NameTypeDescription
idrequired
string (uuid)Segment id
Request
curl -X DELETE "https://your-crm.example.com/api/v1/segments/5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b" \
  -H "Authorization: Bearer $RAABTA_API_KEY"

Errors

StatusCodeWhen
400validation_errorThe body or query failed validation. `details` lists each failing field with a `path` and a `message`.
401unauthorizedNo usable API key: the Authorization header is missing or malformed, or the key is unknown, revoked or expired. The three are deliberately indistinguishable.
403forbiddenThe key is valid but lacks the scope this endpoint requires, or the request came from an address outside the key’s IP allowlist. The message says which.
403account_suspendedThe account this key belongs to is suspended. Rotating the key will not help; contact support.
404not_foundNo such resource in this account. A resource that exists in another account also returns this.
409conflictThe request conflicts with current state: a duplicate phone number on create, an invalid state transition, or an idempotent request that is still in flight.
429rate_limitedThe per-key budget, or the per-IP budget for failed authentication, is exhausted. Honour `Retry-After` before retrying.
500internalSomething failed on our side. Safe to retry with the same Idempotency-Key; quote `request_id` if it persists.