Skip to content

Update Cost Settings

PUT
/org/settings/cost

Replace the cost configuration. Employee keys are email addresses, lowercased.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Labour cost per rep and the commission model. REPLACES the stored config.

object
commission

Commission model. v1 supports none and per_meeting only — revenue_pct needs per-rep deal attribution we don’t have cleanly yet (Phase 2), so it is rejected by the validator.

object
mode
string
default: none
Allowed values: none per_meeting
per_employee_overrides
object
key
additional properties

Optional per-rep commission rate override (else the org default applies).

object
per_meeting_rate
number
per_meeting_rate
number
employees
object
key
additional properties

A single rep’s labor cost. role is informational (sdr/ae/other).

name is intentionally optional (default "") at the API layer — direct API callers may store cost keyed by email alone. The settings UI requires a name for usability; a27/a28 fall back to the email for display when blank.

object
monthly_cost
number
name
string
""
role
string
default: other
Allowed values: sdr ae other
enabled
boolean
version
integer
default: 1

Responses

200

Successful Response

object
data
required

An open envelope for a settings object.

Open because an ontology concept and an SSO config both grow fields as the product does, and on a settings read a dropped field reads as “not configured” 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