Create a deal

POST/api/v1/deals

scope deals:writeIdempotent

Creates a deal. Omit pipeline_id to use the account’s first pipeline, and stage_id to use that pipeline’s first stage. A stage must belong to the chosen pipeline.

Body

application/json

Name	Type	Description
`title`required	`string`
`value`optional	`number`	Defaults to 0
`currency`optional	`string`	ISO 4217; defaults to USD
`pipeline_id`optional	`string (uuid)`	UUID
`stage_id`optional	`string (uuid)`	UUID
`contact_id`optional	`string (uuid) \| null`
`conversation_id`optional	`string (uuid) \| null`
`assigned_to`optional	`string (uuid) \| null`	Member user id from GET /members
`notes`optional	`string \| null`
`expected_close_date`optional	`string \| null`

Request

curl -X POST "https://your-crm.example.com/api/v1/deals" \
  -H "Authorization: Bearer $RAABTA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 6f1c2a9e-3b4d-4c5e-8f7a-9b0c1d2e3f4a" \
  -d '{
    "title": "Khan Trading — annual package",
    "value": 12000,
    "currency": "AED",
    "contact_id": "9d7e4c11-5a2b-4f7c-8e3d-2a1b0c9d8e7f",
    "stage_id": "c3d4e5f6-a7b8-4c9d-8e1f-2a3b4c5d6e7f",
    "expected_close_date": "2026-10-15"
  }'

Response · 201 Created

{
  "data": {
    "id": "e5f6a7b8-c9d0-4e1f-8a3b-4c5d6e7f8a9b",
    "title": "Khan Trading — annual package",
    "value": 12000,
    "currency": "AED",
    "status": "open",
    "pipeline_id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
    "stage_id": "c3d4e5f6-a7b8-4c9d-8e1f-2a3b4c5d6e7f",
    "stage": {
      "id": "c3d4e5f6-a7b8-4c9d-8e1f-2a3b4c5d6e7f",
      "name": "Qualified"
    },
    "contact_id": "9d7e4c11-5a2b-4f7c-8e3d-2a1b0c9d8e7f",
    "conversation_id": null,
    "assigned_to": "2f3e4d5c-6b7a-4c8d-9e0f-1a2b3c4d5e6f",
    "notes": null,
    "expected_close_date": "2026-10-15",
    "created_at": "2026-09-01T08:15:00.000Z",
    "updated_at": "2026-09-02T10:00:00.000Z"
  }
}

Response

Wrapped in { data: … }

Name	Type	Description
`id`required	`string (uuid)`	UUID
`title`required	`string`	What the deal is for
`value`required	`number`	Deal value as a number (the API coerces the decimal column)
`currency`required	`string \| null`	ISO 4217 code
`status`required	`string (enum)`	Outcome; a deal is open until it is closed`openwonlost`
`pipeline_id`required	`string (uuid)`	UUID
`stage_id`required	`string (uuid)`	UUID
`stage`required	`object \| null`	The stage the deal currently sits in
`stage.id`required	`string (uuid)`	UUID
`stage.name`required	`string`	Stage name
`contact_id`required	`string (uuid) \| null`
`conversation_id`required	`string (uuid) \| null`
`assigned_to`required	`string (uuid) \| null`	Member user id
`notes`required	`string \| null`	Free-text notes on the deal
`expected_close_date`required	`string \| null`	YYYY-MM-DD
`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.