Skip to main content
POST
Add several deals at once

Authorizations

Authorization
string
header
required

A workspace API key, created in workspace settings and sent as Authorization: Bearer op_live_…. Session cookies are not accepted. Scopes: signals:read, accounts:read, listeners:read, listeners:analyse, pipeline:read, pipeline:write, collections:write, export:read.

Body

application/json

The signals to open deals from. Duplicates in the list are collapsed first.

signalIds
string[]
required

Up to 200. The cap is a backstop rather than a limit anyone meets: past a couple of hundred this stops being an action somebody took and starts being an import, which wants a job and a progress bar instead.

Required array length: 1 - 200 elements

A signal id.

Required string length: 1 - 120
stage
enum<string>
default:new

Where every created deal lands.

Available options:
new,
contacted,
meeting,
won,
lost
ownerUserId
string

Clerk user id to assign every created deal to.

Maximum string length: 120

Response

What happened, per group. The three counts sum to the deduplicated id count.

What a bulk add did, reported per group rather than as one total. Partial success is the expected outcome, not an error: a selection made from a table will routinely contain signals already on the board.

added
integer
required

Deals created.

duplicate
integer
required

Already on the board. The ordinary case for a re-selected row.

missing
integer
required

Ids that named no signal in this workspace. Reported rather than swallowed: it is the difference between "already on your board" and "those ids do not exist here".