Create Deal · ZeroReach Docs

A deal for a company and its people. It starts in the default pipeline's first open stage unless `pipeline_id` / `stage_id` say otherwise; that stage's required fields must be set (422 `stage_requirements` with `missing`).

API key access

Needs the crm:write scope with an API key (ro_pat_...). A signed-in session uses the caller's role.

POST/api/v1/deals

Authorization

AuthorizationBearer <token>

Access token from /api/v1/auth/login, or an API key (ro_pat_..., RO-176) from /api/v1/workspaces/current/api-keys: the key implies its workspace and needs the route's scope. MCP connectors (/api/v1/mcp only) may use an OAuth access token (ro_oat_..., RO-284).

In: header

Header Parameters

X-Workspace-Id?string | null

Id of the workspace to act on (must be a member).

Request Body

namestring

Length1 <= length <= 200

pipeline_id?string | null

Default: the workspace's default pipeline.

Formatuuid

stage_id?string | null

Default: the pipeline's first open stage.

Formatuuid

company_id?string | null

Formatuuid

contact_ids?array<string> | null

The people (leads) on the deal (at most 50).

Itemsitems <= 50

value?number | null

Formatdouble

Range0 <= value

currency?string | null

ISO 4217 code (default USD).

Length3 <= length <= 3

owner_id?string | null

Default: you.

Formatuuid

close_date?string | null

Formatdate

probability?integer | null

Default: the stage's.

Formatint32

Range0 <= value <= 100

next_step?string | null

Lengthlength <= 300

Response Body

curl -X POST "http://localhost:8000/api/v1/deals" \
  -H "X-Workspace-Id: string" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string"
  }'

curl -X POST "http://localhost:8000/api/v1/deals" \  -H "X-Workspace-Id: string" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "pipeline_id": "ec036e81-7903-4e4d-bbfa-ac8516341cf0",
  "stage_id": "f38d2b9c-0a0a-4eea-91a8-e974413bb670",
  "stage_name": "string",
  "name": "string",
  "company_id": "b2e6a1c3-1a5e-44ae-a8fd-81f76fd715cf",
  "company_name": "string",
  "value": 0,
  "currency": "string",
  "owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
  "owner_name": "string",
  "close_date": "2019-08-24",
  "probability": 0,
  "probability_set": true,
  "weighted_value": 0,
  "next_step": "string",
  "position": 0.1,
  "status": "open",
  "closed_at": "2019-08-24T14:15:22Z",
  "contacts": [
    {
      "lead_id": "9bddab70-98e6-43a9-8f32-c9788b9de0c0",
      "name": "string",
      "email": "string",
      "title": "string"
    }
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}