Skip to main content
GET
Get lead custom field requirements

Authorizations

Authorization
string
header
required

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

Path Parameters

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

Response

200 - application/json

Default Response

fields
object[]
required
rules
object[]
required
standard_fields
object[]
required

The built-in fields of the lead (getPartnerLeadRequirements) or deal (getPartnerDealRequirements) a partner can set, each with whether this API rejects a create without it (required), whether the company has locked it, and its help text. A field the company does not share with partners is left out: it reads as null and cannot be set.

status_forms
object

getPartnerLeadRequirements only: the forms a partner fills in when moving a lead to converted (Accepted) or rejected with updatePartnerLead.