Docs
OverviewGuidesZero & MCPAPI referenceChangelog
CRM

Create Activity Type

A custom activity kind (at most 50). 409 `activity_type_exists`.

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/activity-types

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

labelstring
Length1 <= length <= 60
key?string | null

Default: from the label (Coffee chat -> coffee_chat).

Length1 <= length <= 40

Response Body

curl -X POST "http://localhost:8000/api/v1/activity-types" \  -H "X-Workspace-Id: string" \  -H "Content-Type: application/json" \  -d '{    "label": "string"  }'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "key": "string",
  "label": "string",
  "builtin": true
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Accept Stage Suggestion

Move the deal to the suggested stage (one click). The stage's required fields apply (422 `stage_requirements`); 409 `suggestion_decided` when it was already accepted, dismissed or superseded.

Create Deal

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`).