Docs
OverviewGuidesZero & MCPAPI referenceChangelog
AI

Update Ai Column

Rename a column or change its prompt or options. Finished cells are kept and show `stale` until they run again.

API key access

Needs the leads:write scope with an API key (ro_pat_...). A signed-in session uses the caller's role.
PATCH/api/v1/ai-columns/{column_id}

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

Path Parameters

column_idstring

The column.

Formatuuid

Header Parameters

X-Workspace-Id?string | null

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

Request Body

name?string | null
Length1 <= length <= 80
prompt?string | null

A new prompt: finished cells show stale until they run again.

Length3 <= length <= 2000
options?array<string> | null
Itemsitems <= 12

Response Body

curl -X PATCH "http://localhost:8000/api/v1/ai-columns/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "X-Workspace-Id: string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "entity": "string",
  "name": "string",
  "prompt": "string",
  "kind": "string",
  "options": [
    "string"
  ],
  "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "cells": {
    "pending": 0,
    "running": 0,
    "done": 0,
    "failed": 0
  },
  "credits": 0
}
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Run Ai Column

Queue the column's cells for the given rows (RO-340); a background job fills them through the provider layer, one small AI call per row, charged as AI credits (task `ai_column`). Cells with a result are kept unless `force`. Show the cost first with `POST /ai-credits/estimate` (`action` `ai_column`, `items`). 429 `ai_credits_exhausted` / `ai_credits_user_limit` at the monthly allowance or the member's limit; 429 `ai_columns_daily_limit` past 500 cells a day per workspace.

Analytics Summary

Every metric summed over a range of UTC days (both ends inclusive; default: the 30 days ending today, at most 366), from the daily rollups, plus derived rates. Rollups are updated by the `analytics.rollup` job every few minutes (`as_of`). `sequence_id`, `channel` and `mailbox_id` repeat to match any of them.