Skip to main content
POST
Create a deal partner role

Authorizations

Authorization
string
header
required

API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".

Body

application/json
partner_type
enum<string>
required
Available options:
referral,
reseller
label
string
required
Required string length: 1 - 30
kind
enum<string>
default:supporting
required

Which list the role joins: supporting (the default) for supporting partners, primary for the deal's primary partner.

Available options:
primary,
supporting

Response

201 - application/json

Default Response

uuid
string
required
partner_type
enum<string>
required
Available options:
referral,
reseller,
distributor
kind
enum<string>
required

supporting: a role for supporting partners. primary: a role for the deal's primary partner.

Available options:
primary,
supporting
label
string
required
sort_order
number
required
archived
boolean
required

Archived roles are no longer offered for new assignments.

in_use
boolean
required

Some deal carries this role (a supporting partner's role, or a primary partner role picked on the deal), so deleting it archives it instead.