Skip to main content
POST
Add a supporting partner to a deal

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
partnership_uuid
string<uuid>
required

The supporting partner's uuid. It must be an active partner of the deal's partner type, and not the deal's primary partner or a distributor.

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)$
role_uuid
string<uuid> | null

A deal partner role of the deal's partner type (listDealPartnerRoles). Omitted or null means no role: re-posting an attached partner without it clears its role.

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)$

Response

201 - application/json

Default Response

uuid
string
required

The partner's (partnership's) uuid.

name
string | null
required
partner_type
enum<string>
required
Available options:
referral,
reseller,
distributor
role
object | null
required

The partner's role on this deal (a deal partner role). For the primary partner: the role the vendor picked from the primary partner roles of the deal's partner type, or the first of those roles when none was picked; null when that partner type has no primary roles. For a supporting partner: its supporting role, or null for none. Always null while the Co-selling module is off.

is_primary
boolean
required

True for the deal's primary partner (the deal's partner); false for a supporting (co-sell) partner.