Skip to content

Create Deal Column

POST
/deals/columns/create

Add a custom column.

list_id null creates a GLOBAL column, visible on every deals grid in the org. That is the wider blast radius of the two, so it is what you get by omission only because it is the app’s own default.

The path is /columns/create rather than a POST to /columns, matching the app exactly - a different spelling here would be a second way to say the same thing.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Add a custom column to the deals grid.

object
data_type

Closed to what the app accepts. It validates this inside the handler, so a free string would raise there and escape as a 500 instead of a 422 naming the valid types.

string
default: text
Allowed values: text int numeric number boolean date
list_id
Any of:
integer
title
required

Display name.

string
>= 1 characters <= 100 characters

Responses

201

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