Skip to main content
PATCH
Rename a deal partner role

Authorizations

Authorization
string
header
required

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

Path Parameters

uuid
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json
label
string
required
Required string length: 1 - 30

Response

200 - 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.