Deals

Create Deal Column

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.

post/deals/columns/create

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/deals/columns/create
  • Auth: HTTP bearer

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

titlestring required

Display name.

data_type'text' | 'int' | 'numeric' | 'number' | 'boolean' | 'date'

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.

list_idinteger nullable

Scope the column to one list. Null creates a GLOBAL column.

Response

Successful Response

dataDealPayload 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".

Changes

No recorded changes to this operation across all 2 revisions of this API.