Skip to content

Bulk Update Deals

POST
/deals/bulk

Apply ONE change to up to 100 deals.

PUT semantics on every field of change: null leaves a value alone, an EMPTY STRING clears it. Omitting a field and sending "" are therefore different instructions and the second one is destructive.

Read the per-deal result rather than the HTTP status: a deal the caller cannot write is reported, not fatal.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Apply one change to up to 100 deals.

Each deal is checked against the caller’s deal scope individually; one the caller cannot write is reported rather than aborting the batch.

object
change
required

The change applied to EVERY deal in the batch.

PUT semantics, and the distinction matters: null leaves a value alone, an EMPTY STRING clears it. So omitting a field and sending "" are different instructions, and the second one is destructive.

object
amount
Any of:
number
close_date
Any of:
string format: date-time
currency
Any of:
string
custom_fields
Any of:
object
key
additional properties
any
description
Any of:
string
next_step
Any of:
string
owner_id
Any of:
string
pipeline_id
Any of:
string
stage
Any of:
string
stage_id
Any of:
string
deal_ids
required
Array<string>
>= 1 items <= 100 items

Responses

200

Successful Response

object
data
required

An open envelope for a deal, a merge preview or a column result.

Open because the crossfire and merge-preview payloads are computed shapes that grow with the product, and a closed model would drop a field from an ADVISORY read - where a missing signal reads as “nothing to worry about” rather than “we did not tell you”.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string