Create a segment

POST/api/v1/segments

scope contacts:writeIdempotent

Creates an empty segment. Add contacts to it with POST /segments/{id}/contacts.

Body

application/json

Name	Type	Description
`name`required	`string`	The segment’s name
`description`optional	`string \| null`	What it is for
`color`optional	`string`	Six-digit hex colour, e.g. #3b82f6

Request

curl -X POST "https://your-crm.example.com/api/v1/segments" \
  -H "Authorization: Bearer $RAABTA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 6f1c2a9e-3b4d-4c5e-8f7a-9b0c1d2e3f4a" \
  -d '{
    "name": "Website leads — September",
    "description": "Everyone who booked through the website this month"
  }'

Response · 201 Created

{
  "data": {
    "id": "5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b",
    "name": "Website leads — September",
    "description": "Everyone who booked through the website this month",
    "color": "#3b82f6",
    "member_count": 0,
    "created_at": "2026-09-01T08:00:00.000Z",
    "updated_at": "2026-09-02T10:00:00.000Z"
  }
}

Response

Wrapped in { data: … }

Name	Type	Description
`id`required	`string (uuid)`	UUID
`name`required	`string`	The segment’s name
`description`required	`string \| null`	What the segment is for
`color`required	`string`	Hex colour used for the segment in the dashboard
`member_count`required	`integer`	How many contacts are in the segment. Counts contacts on a member’s private number too, which the API never lists, so it can be higher than the contacts you can page through
`created_at`required	`string (date-time)`	ISO 8601 timestamp
`updated_at`required	`string (date-time)`	ISO 8601 timestamp

Errors

Status	Code	When
400	`bad_request`	The request could not be parsed: malformed JSON, an invalid cursor, or a query parameter of the wrong shape.
400	`validation_error`	The body or query failed validation. `details` lists each failing field with a `path` and a `message`.
401	`unauthorized`	No usable API key: the Authorization header is missing or malformed, or the key is unknown, revoked or expired. The three are deliberately indistinguishable.
403	`forbidden`	The 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.
403	`account_suspended`	The account this key belongs to is suspended. Rotating the key will not help; contact support.
409	`conflict`	The request conflicts with current state: a duplicate phone number on create, an invalid state transition, or an idempotent request that is still in flight.
422	`unprocessable`	The request was well-formed but cannot be carried out. `reason` is a stable string saying why (for example `outside_window` or `stage_not_in_pipeline`).
429	`rate_limited`	The per-key budget, or the per-IP budget for failed authentication, is exhausted. Honour `Retry-After` before retrying.
500	`internal`	Something failed on our side. Safe to retry with the same Idempotency-Key; quote `request_id` if it persists.