Skip to content

Create Deal Close Reason

POST
/deals/close-reasons

Add a close reason.

ENTRY GATE: _REASON_MUTATE_PERMISSIONS, the SAME route dependency the app declares - wider than the manager tier (a rep may extend the list inline while closing their own deal) but NOT open to org members with no deal access. can_manage is still resolved for the handler; may_seed is now enforced by the route gate rather than discarded.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Add a close reason.

Adding one is gated on _REASON_MUTATE_PERMISSIONS (the app’s own route gate): deliberately wider than the manager tier - a rep extends the list inline while closing their own deal - but NOT open to org members with no deal access. REMOVING one carries the same entry gate plus a creator-or- manager check, because manager-only removal would make every rep’s typo permanent and org-wide.

object
kind
required

Which list this reason belongs to, e.g. won or lost.

string
label
required
string
>= 1 characters <= 255 characters

Responses

201

Successful Response

object
data
required

Whatever the operation returns, carried through whole.

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