Docs
OverviewGuidesZero & MCPAPI referenceChangelog
Signals

Update Signal Rule

Change any field of a rule (admin+); `sequence_id: null` clears it.

API key access

Needs the admin scope with an API key (ro_pat_...). A signed-in session uses the caller's role.
PATCH/api/v1/signal-rules/{rule_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

rule_idstring
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 <= 200
action?SignalRuleAction | null
enabled?boolean | null
kinds?array<SignalKind> | null
Itemsitems <= 5
keywords?array<string> | null
Itemsitems <= 20
sequence_id?string | null
Formatuuid
max_leads?integer | null
Formatint64
Range1 <= value <= 100

Response Body

curl -X PATCH "http://localhost:8000/api/v1/signal-rules/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "X-Workspace-Id: string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
  "name": "string",
  "enabled": true,
  "kinds": [
    "hiring"
  ],
  "keywords": [
    "string"
  ],
  "action": "notify",
  "sequence_id": "7cd84c09-94f4-486c-9c49-de3b9cf3f74f",
  "max_leads": 0,
  "created_by_id": "9377d689-01fb-4abf-8450-3368d2c1924f",
  "fired_count": 0,
  "last_fired_at": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}
Empty
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Scan Company For Signals

Watch the company (pinned) and check it in the next scan batch (202). Its careers, pricing and about pages are re-crawled politely with conditional GETs. 404 for a missing company, 422 when it has no domain.

Get Speed To Lead

Speed-to-lead settings: whether new webhook leads are called automatically, the webhook URL and key prefix, and whether outbound calling is configured on the server.