Skip to content

Set Deal Column Values

PUT
/deals/{deal_id}/columns/values

Write custom column values on one deal.

A null CLEARS that column rather than leaving it alone. Keys come from GET /deals/columns; anything else is refused.

Authorizations

Parameters

Path Parameters

deal_id
required

Deal id (UUID).

string

Deal id (UUID).

Query Parameters

list_id
Any of:
integer

Resolve list-scoped columns against this list.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Write custom column values on one deal.

null CLEARS a value rather than leaving it alone - this is a write of exactly what you send, not a patch that skips nulls.

object
values
required

Column key -> value. A null clears that column.

object
key
additional properties
Any of:
string

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
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

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