Create Task

A task, optionally on a lead, company or deal, with a due time and an owner (default you).

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/tasks

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

titlestring

Length1 <= length <= 300

notes?string | null

Lengthlength <= 10000

due_at?string | null

Formatdate-time

owner_id?string | null

Default: you; null: nobody.

Formatuuid

status?TaskStatus | null

lead_id?string | null

Formatuuid

company_id?string | null

Formatuuid

deal_id?string | null

Formatuuid

Response Body

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

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

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "title": "string",
  "notes": "string",
  "due_at": "2019-08-24T14:15:22Z",
  "owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
  "owner_name": "string",
  "status": "open",
  "completed_at": "2019-08-24T14:15:22Z",
  "source": "user",
  "lead_id": "9bddab70-98e6-43a9-8f32-c9788b9de0c0",
  "company_id": "b2e6a1c3-1a5e-44ae-a8fd-81f76fd715cf",
  "deal_id": "2fa5b64f-5b72-4263-958e-07b76f41abe3",
  "record_label": "string",
  "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

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

Authorization

Header Parameters

Request Body

Response Body

201

422