Returns the custom fields and rules that createPartnerLead and updatePartnerLead enforce for this partnership — the fields (with their required flag) and active rules (visibility, locking, auto-population) a lead submission must satisfy — and status_forms: the shared fields and reason a status change to converted (Accepted) or rejected carries, and whether that form is off, optional or required — and standard_fields: the built-in lead fields the company shares with partners, with whether createPartnerLead rejects a request without each (required), whether it is locked, and its help text. Locked fields, which only the company can set, are never listed in fields. A rule’s source_field may still name a locked field: its value appears read-only on the lead or deal record (custom_fields, with locked: true), not in fields.
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.
Show child attributes
status_forms
object
getPartnerLeadRequirements only: the forms a partner fills in when moving a lead to converted (Accepted) or rejected with updatePartnerLead.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Journeybee API","colors":{"primary":"#007aff"},"logo":{"light":"https://mintcdn.com/journeybee/OYst47RAi-INCv0T/logo-light.svg?fit=max\u0026auto=format\u0026n=OYst47RAi-INCv0T\u0026q=85\u0026s=8afc66d3e6015e470883014b04a24784","dark":"https://mintcdn.com/journeybee/OYst47RAi-INCv0T/logo-dark.svg?fit=max\u0026auto=format\u0026n=OYst47RAi-INCv0T\u0026q=85\u0026s=0911c07015635ad1edf6f86660d20de5"},"api":{"playground":{"display":"interactive"}},"navbar":{"links":[{"href":"https://support.journeybee.io","label":"Support"},{"href":"https://app.journeybee.io","label":"Dashboard"}]},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/journeybee-partners"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"journeybee","hasAudioNarration":false,"actualSubdomain":"journeybee","customDomains":["docs.journeybee.io"],"gitSource":{"type":"github","owner":"journeybeeio","repo":"journeybee","deployBranch":"master","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6afa1ae08deffcac16ff58f1","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"API Reference","count":758},{"language":"default","tag":"Analytics","count":27},{"language":"default","tag":"Webhook Events","count":16},{"language":"default","tag":"Guides","count":13},{"language":"default","tag":"Partner API","count":13},{"language":"default","tag":"Campaign Audience","count":12},{"language":"default","tag":"Proposals","count":12},{"language":"default","tag":"Room Secure Files","count":12},{"language":"default","tag":"Partner API Reference","count":11},{"language":"default","tag":"Partner","count":11}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"partner-api-reference/partner/get-lead-custom-field-requirements","slug":"/partner-api-reference/partner/get-lead-custom-field-requirements","pageMetadata":{"title":"Get lead custom field requirements","description":"Returns the custom fields and rules that createPartnerLead and updatePartnerLead enforce for this partnership — the fields (with their required flag) and active rules (visibility, locking, auto-population) a lead submission must satisfy — and `status_forms`: the shared fields and reason a status change to converted (Accepted) or rejected carries, and whether that form is off, optional or required — and `standard_fields`: the built-in lead fields the company shares with partners, with whether createPartnerLead rejects a request without each (`required`), whether it is locked, and its help text. Locked fields, which only the company can set, are never listed in `fields`. A rule's `source_field` may still name a locked field: its value appears read-only on the lead or deal record (`custom_fields`, with `locked: true`), not in `fields`.","deprecated":null,"version":null,"openapi":"/partner-openapi.json get /partner/{partnershipId}/leads/requirements","href":"/partner-api-reference/partner/get-lead-custom-field-requirements","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Returns the custom fields and rules that createPartnerLead and updatePartnerLead enforce for this partnership — the fields (with their required flag) and active rules (visibility, locking, auto-population) a lead submission must satisfy — and \", _jsx(_components.code, {\n children: \"status_forms\"\n }), \": the shared fields and reason a status change to converted (Accepted) or rejected carries, and whether that form is off, optional or required — and \", _jsx(_components.code, {\n children: \"standard_fields\"\n }), \": the built-in lead fields the company shares with partners, with whether createPartnerLead rejects a request without each (\", _jsx(_components.code, {\n children: \"required\"\n }), \"), whether it is locked, and its help text. Locked fields, which only the company can set, are never listed in \", _jsx(_components.code, {\n children: \"fields\"\n }), \". A rule’s \", _jsx(_components.code, {\n children: \"source_field\"\n }), \" may still name a locked field: its value appears read-only on the lead or deal record (\", _jsx(_components.code, {\n children: \"custom_fields\"\n }), \", with \", _jsx(_components.code, {\n children: \"locked: true\"\n }), \"), not in \", _jsx(_components.code, {\n children: \"fields\"\n }), \".\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get lead custom field requirements","description":"Returns the custom fields and rules that createPartnerLead and updatePartnerLead enforce for this partnership — the fields (with their required flag) and active rules (visibility, locking, auto-population) a lead submission must satisfy — and `status_forms`: the shared fields and reason a status change to converted (Accepted) or rejected carries, and whether that form is off, optional or required — and `standard_fields`: the built-in lead fields the company shares with partners, with whether createPartnerLead rejects a request without each (`required`), whether it is locked, and its help text. Locked fields, which only the company can set, are never listed in `fields`. A rule's `source_field` may still name a locked field: its value appears read-only on the lead or deal record (`custom_fields`, with `locked: true`), not in `fields`.","deprecated":null,"version":null,"openapi":"/partner-openapi.json get /partner/{partnershipId}/leads/requirements","href":"/partner-api-reference/partner/get-lead-custom-field-requirements","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getPartnerLeadRequirements","summary":"Get lead custom field requirements","tags":["Partner"],"description":"Returns the custom fields and rules that createPartnerLead and updatePartnerLead enforce for this partnership — the fields (with their required flag) and active rules (visibility, locking, auto-population) a lead submission must satisfy — and `status_forms`: the shared fields and reason a status change to converted (Accepted) or rejected carries, and whether that form is off, optional or required — and `standard_fields`: the built-in lead fields the company shares with partners, with whether createPartnerLead rejects a request without each (`required`), whether it is locked, and its help text. Locked fields, which only the company can set, are never listed in `fields`. A rule's `source_field` may still name a locked field: its value appears read-only on the lead or deal record (`custom_fields`, with `locked: true`), not in `fields`.","parameters":["cc0f139f-9b36-4f66-96af-360d2171c2ae"],"x-capability":{"contract_version":2,"key":"openapi:partner.getPartnerLeadRequirements","version":1,"identity":{"source":"openapi","name":"call_endpoint","operationId":"getPartnerLeadRequirements","method":"GET","surface":"partner"},"operation":{"kind":"read","risk":"read","approval_policy":"none"},"access":{"read":true,"write":false},"access_mode":"all","scope_key":"leads","actors":["partner"],"requirements":{"modules":["partner_api"],"program_modules":[],"workflow_management":false},"scope":{"object_definitions":[],"programs":[],"portal_membership":"not_applicable"},"entity_kinds":[],"idempotency":{"mode":"none","dry_run":false,"reversible":true},"presentation":{"title":"Get lead custom field requirements","summary":"Returns the custom fields and rules that createPartnerLead and updatePartnerLead enforce for this partnership — the fields (with their required flag) and active rules (visibility, locking, auto-population) a lead submission must satisfy — and `status_forms`: the shared fields and reason a status change to converted (Accepted) or rejected carries, and whether that form is off, optional or required — and `standard_fields`: the built-in lead fields the company shares with partners, with whether createPartnerLead rejects a request without each (`required`), whether it is locked, and its help text. Locked fields, which only the company can set, are never listed in `fields`. A rule's `source_field` may still name a locked field: its value appears read-only on the lead or deal record (`custom_fields`, with `locked: true`), not in `fields`.","domain":"Partner","surface":"partner"}},"responses":{"200":"13cfe78c-104c-4925-b6e7-206fcc8bd295"},"method":"get","type":"path","servers":["e0c483a8-4d49-4ce8-8e24-4be11d00d28b"],"security":["ee7e257a-1749-4101-b33f-5219b49f324a"],"path":"/partner/{partnershipId}/leads/requirements","baseUrlOptions":["https://api.journeybee.io/v1"],"title":"Get lead custom field requirements","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"cc0f139f-9b36-4f66-96af-360d2171c2ae":{"schema":{"type":"string","format":"uuid","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)$","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"},"in":"path","name":"partnershipId","required":true}},"responses":{"13cfe78c-104c-4925-b6e7-206fcc8bd295":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"fields.items.[INDEX].id","typeLabel":"string"},"label":{"type":"string","isRequired":true,"uniqueKey":"fields.items.[INDEX].label","typeLabel":"string"},"type":{"type":"string","enum":["text","textarea","email","website","phone","number","date","boolean","checkbox","select","multi_select","file"],"isRequired":true,"uniqueKey":"fields.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","isRequired":true,"uniqueKey":"fields.items.[INDEX].required","typeLabel":"boolean"},"options":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","isRequired":true,"uniqueKey":"fields.items.[INDEX].options.oneOf.0.items.[INDEX].id","typeLabel":"number"},"label":{"type":"string","isRequired":true,"uniqueKey":"fields.items.[INDEX].options.oneOf.0.items.[INDEX].label","typeLabel":"string"}},"required":["id","label"],"additionalProperties":false,"uniqueKey":"fields.items.[INDEX].options.oneOf.0.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"fields.items.[INDEX].options.oneOf.0","typeLabel":"object[]"},{"type":"null","isRequired":true,"uniqueKey":"fields.items.[INDEX].options.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"fields.items.[INDEX].options","typeLabel":"object[] | null"},"description":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"fields.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"fields.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"fields.items.[INDEX].description","typeLabel":"string | null"},"link_url":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"fields.items.[INDEX].link_url.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"fields.items.[INDEX].link_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"fields.items.[INDEX].link_url","typeLabel":"string | null"},"link_label":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"fields.items.[INDEX].link_label.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"fields.items.[INDEX].link_label.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"fields.items.[INDEX].link_label","typeLabel":"string | null"}},"required":["id","label","type","required","options","description","link_url","link_label"],"additionalProperties":false,"uniqueKey":"fields.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"fields","typeLabel":"object[]"},"rules":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"rules.items.[INDEX].id","typeLabel":"string"},"label":{"type":"string","isRequired":true,"uniqueKey":"rules.items.[INDEX].label","typeLabel":"string"},"action_type":{"type":"string","enum":["set_value","show_field","value_mapping"],"isRequired":true,"uniqueKey":"rules.items.[INDEX].action_type","typeLabel":"enum\u003cstring>"},"source_field":{"type":"string","isRequired":true,"uniqueKey":"rules.items.[INDEX].source_field","typeLabel":"string"},"source_values":{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"rules.items.[INDEX].source_values.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"rules.items.[INDEX].source_values.items.[INDEX].oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"rules.items.[INDEX].source_values.items.[INDEX].oneOf.2","typeLabel":"boolean"},{"type":"object","required":["operator","value"],"properties":{"operator":{"type":"string","enum":[">=","\u003c=",">","\u003c","==","!="],"isRequired":true,"uniqueKey":"rules.items.[INDEX].source_values.items.[INDEX].oneOf.3.operator","typeLabel":"enum\u003cstring>"},"value":{"type":"number","isRequired":true,"uniqueKey":"rules.items.[INDEX].source_values.items.[INDEX].oneOf.3.value","typeLabel":"number"}},"additionalProperties":false,"uniqueKey":"rules.items.[INDEX].source_values.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","required":["operator","min","max"],"properties":{"operator":{"type":"string","enum":["between"],"isRequired":true,"uniqueKey":"rules.items.[INDEX].source_values.items.[INDEX].oneOf.4.operator","typeLabel":"enum\u003cstring>"},"min":{"type":"number","isRequired":true,"uniqueKey":"rules.items.[INDEX].source_values.items.[INDEX].oneOf.4.min","typeLabel":"number"},"max":{"type":"number","isRequired":true,"uniqueKey":"rules.items.[INDEX].source_values.items.[INDEX].oneOf.4.max","typeLabel":"number"}},"additionalProperties":false,"uniqueKey":"rules.items.[INDEX].source_values.items.[INDEX].oneOf.4","typeLabel":"object"}],"uniqueKey":"rules.items.[INDEX].source_values.items.[INDEX]","typeLabel":"string · number · boolean · object · object"},"isRequired":true,"uniqueKey":"rules.items.[INDEX].source_values","typeLabel":"string · number · boolean · object · object[]"},"conditions":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"rules.items.[INDEX].conditions.items.[INDEX].field","typeLabel":"string"},"values":{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"rules.items.[INDEX].conditions.items.[INDEX].values.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"rules.items.[INDEX].conditions.items.[INDEX].values.items.[INDEX].oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"rules.items.[INDEX].conditions.items.[INDEX].values.items.[INDEX].oneOf.2","typeLabel":"boolean"},{"type":"object","required":["operator","value"],"properties":{"operator":{"type":"string","enum":[">=","\u003c=",">","\u003c","==","!="],"isRequired":true,"uniqueKey":"rules.items.[INDEX].conditions.items.[INDEX].values.items.[INDEX].oneOf.3.operator","typeLabel":"enum\u003cstring>"},"value":{"type":"number","isRequired":true,"uniqueKey":"rules.items.[INDEX].conditions.items.[INDEX].values.items.[INDEX].oneOf.3.value","typeLabel":"number"}},"additionalProperties":false,"uniqueKey":"rules.items.[INDEX].conditions.items.[INDEX].values.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","required":["operator","min","max"],"properties":{"operator":{"type":"string","enum":["between"],"isRequired":true,"uniqueKey":"rules.items.[INDEX].conditions.items.[INDEX].values.items.[INDEX].oneOf.4.operator","typeLabel":"enum\u003cstring>"},"min":{"type":"number","isRequired":true,"uniqueKey":"rules.items.[INDEX].conditions.items.[INDEX].values.items.[INDEX].oneOf.4.min","typeLabel":"number"},"max":{"type":"number","isRequired":true,"uniqueKey":"rules.items.[INDEX].conditions.items.[INDEX].values.items.[INDEX].oneOf.4.max","typeLabel":"number"}},"additionalProperties":false,"uniqueKey":"rules.items.[INDEX].conditions.items.[INDEX].values.items.[INDEX].oneOf.4","typeLabel":"object"}],"uniqueKey":"rules.items.[INDEX].conditions.items.[INDEX].values.items.[INDEX]","typeLabel":"string · number · boolean · object · object"},"isRequired":true,"uniqueKey":"rules.items.[INDEX].conditions.items.[INDEX].values","typeLabel":"string · number · boolean · object · object[]"}},"required":["field","values"],"additionalProperties":false,"uniqueKey":"rules.items.[INDEX].conditions.items.[INDEX]","typeLabel":"object"},"description":"Extra conditions beyond source_field/source_values. For show_field and set_value they combine with the primary condition using condition_operator; for value_mapping they form a gate combined among themselves with condition_operator, and the first matching value_mappings row applies only while the gate passes.","isRequired":true,"uniqueKey":"rules.items.[INDEX].conditions","typeLabel":"object[]"},"condition_operator":{"type":"string","enum":["and","or"],"isRequired":true,"uniqueKey":"rules.items.[INDEX].condition_operator","typeLabel":"enum\u003cstring>"},"target_field":{"type":"string","isRequired":true,"uniqueKey":"rules.items.[INDEX].target_field","typeLabel":"string"},"target_value":{"oneOf":[{"type":"object","properties":{"text":{"oneOf":[{"type":"string","description":"Value for text-like fields","uniqueKey":"rules.items.[INDEX].target_value.oneOf.0.text.oneOf.0","typeLabel":"string"},{"type":"null","description":"Value for text-like fields","uniqueKey":"rules.items.[INDEX].target_value.oneOf.0.text.oneOf.1","typeLabel":"null"}],"uniqueKey":"rules.items.[INDEX].target_value.oneOf.0.text","typeLabel":"string | null"},"textarea":{"oneOf":[{"type":"string","description":"Legacy value key for textarea fields; write using text","uniqueKey":"rules.items.[INDEX].target_value.oneOf.0.textarea.oneOf.0","typeLabel":"string"},{"type":"null","description":"Legacy value key for textarea fields; write using text","uniqueKey":"rules.items.[INDEX].target_value.oneOf.0.textarea.oneOf.1","typeLabel":"null"}],"uniqueKey":"rules.items.[INDEX].target_value.oneOf.0.textarea","typeLabel":"string | null"},"number":{"oneOf":[{"type":"number","description":"Value for number fields","uniqueKey":"rules.items.[INDEX].target_value.oneOf.0.number.oneOf.0","typeLabel":"number"},{"type":"string","description":"Value for number fields","uniqueKey":"rules.items.[INDEX].target_value.oneOf.0.number.oneOf.1","typeLabel":"string"},{"type":"null","description":"Value for number fields","uniqueKey":"rules.items.[INDEX].target_value.oneOf.0.number.oneOf.2","typeLabel":"null"}],"uniqueKey":"rules.items.[INDEX].target_value.oneOf.0.number","typeLabel":"number | string | null"},"date":{"oneOf":[{"type":"string","description":"Value for date fields (ISO 8601 date string)","uniqueKey":"rules.items.[INDEX].target_value.oneOf.0.date.oneOf.0","typeLabel":"string"},{"type":"null","description":"Value for date fields (ISO 8601 date string)","uniqueKey":"rules.items.[INDEX].target_value.oneOf.0.date.oneOf.1","typeLabel":"null"}],"uniqueKey":"rules.items.[INDEX].target_value.oneOf.0.date","typeLabel":"string | null"},"boolean":{"oneOf":[{"type":"boolean","description":"Value for checkbox fields","uniqueKey":"rules.items.[INDEX].target_value.oneOf.0.boolean.oneOf.0","typeLabel":"boolean"},{"type":"string","description":"Value for checkbox fields","uniqueKey":"rules.items.[INDEX].target_value.oneOf.0.boolean.oneOf.1","typeLabel":"string"},{"type":"null","description":"Value for checkbox fields","uniqueKey":"rules.items.[INDEX].target_value.oneOf.0.boolean.oneOf.2","typeLabel":"null"}],"uniqueKey":"rules.items.[INDEX].target_value.oneOf.0.boolean","typeLabel":"boolean | string | null"},"select":{"oneOf":[{"type":"number","description":"Option ID for single-select fields","uniqueKey":"rules.items.[INDEX].target_value.oneOf.0.select.oneOf.0","typeLabel":"number"},{"type":"null","description":"Option ID for single-select fields","uniqueKey":"rules.items.[INDEX].target_value.oneOf.0.select.oneOf.1","typeLabel":"null"}],"uniqueKey":"rules.items.[INDEX].target_value.oneOf.0.select","typeLabel":"number | null"},"multi_select":{"oneOf":[{"type":"array","items":{"type":"number","uniqueKey":"rules.items.[INDEX].target_value.oneOf.0.multi_select.oneOf.0.items.[INDEX]","typeLabel":"number"},"description":"Option IDs for multi-select fields","uniqueKey":"rules.items.[INDEX].target_value.oneOf.0.multi_select.oneOf.0","typeLabel":"number[]"},{"type":"null","description":"Option IDs for multi-select fields","uniqueKey":"rules.items.[INDEX].target_value.oneOf.0.multi_select.oneOf.1","typeLabel":"null"}],"uniqueKey":"rules.items.[INDEX].target_value.oneOf.0.multi_select","typeLabel":"number[] | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"rules.items.[INDEX].target_value.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"rules.items.[INDEX].target_value.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"rules.items.[INDEX].target_value","typeLabel":"object | null"},"value_mappings":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"sourceValue":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"rules.items.[INDEX].value_mappings.oneOf.0.items.[INDEX].sourceValue.oneOf.0","typeLabel":"string"},{"type":"number","isRequired":true,"uniqueKey":"rules.items.[INDEX].value_mappings.oneOf.0.items.[INDEX].sourceValue.oneOf.1","typeLabel":"number"},{"type":"boolean","isRequired":true,"uniqueKey":"rules.items.[INDEX].value_mappings.oneOf.0.items.[INDEX].sourceValue.oneOf.2","typeLabel":"boolean"},{"type":"object","required":["operator","value"],"properties":{"operator":{"type":"string","enum":[">=","\u003c=",">","\u003c","==","!="],"isRequired":true,"uniqueKey":"rules.items.[INDEX].value_mappings.oneOf.0.items.[INDEX].sourceValue.oneOf.3.operator","typeLabel":"enum\u003cstring>"},"value":{"type":"number","isRequired":true,"uniqueKey":"rules.items.[INDEX].value_mappings.oneOf.0.items.[INDEX].sourceValue.oneOf.3.value","typeLabel":"number"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"rules.items.[INDEX].value_mappings.oneOf.0.items.[INDEX].sourceValue.oneOf.3","typeLabel":"object"},{"type":"object","required":["operator","min","max"],"properties":{"operator":{"type":"string","enum":["between"],"isRequired":true,"uniqueKey":"rules.items.[INDEX].value_mappings.oneOf.0.items.[INDEX].sourceValue.oneOf.4.operator","typeLabel":"enum\u003cstring>"},"min":{"type":"number","isRequired":true,"uniqueKey":"rules.items.[INDEX].value_mappings.oneOf.0.items.[INDEX].sourceValue.oneOf.4.min","typeLabel":"number"},"max":{"type":"number","isRequired":true,"uniqueKey":"rules.items.[INDEX].value_mappings.oneOf.0.items.[INDEX].sourceValue.oneOf.4.max","typeLabel":"number"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"rules.items.[INDEX].value_mappings.oneOf.0.items.[INDEX].sourceValue.oneOf.4","typeLabel":"object"}],"isRequired":true,"uniqueKey":"rules.items.[INDEX].value_mappings.oneOf.0.items.[INDEX].sourceValue","typeLabel":"string · number · boolean · object · object"},"targetValue":{"type":"object","properties":{"text":{"oneOf":[{"type":"string","description":"Value for text-like fields","uniqueKey":"rules.items.[INDEX].value_mappings.oneOf.0.items.[INDEX].targetValue.text.oneOf.0","typeLabel":"string"},{"type":"null","description":"Value for text-like fields","uniqueKey":"rules.items.[INDEX].value_mappings.oneOf.0.items.[INDEX].targetValue.text.oneOf.1","typeLabel":"null"}],"uniqueKey":"rules.items.[INDEX].value_mappings.oneOf.0.items.[INDEX].targetValue.text","typeLabel":"string | null"},"textarea":{"oneOf":[{"type":"string","description":"Legacy value key for textarea fields; write using text","uniqueKey":"rules.items.[INDEX].value_mappings.oneOf.0.items.[INDEX].targetValue.textarea.oneOf.0","typeLabel":"string"},{"type":"null","description":"Legacy value key for textarea fields; write using text","uniqueKey":"rules.items.[INDEX].value_mappings.oneOf.0.items.[INDEX].targetValue.textarea.oneOf.1","typeLabel":"null"}],"uniqueKey":"rules.items.[INDEX].value_mappings.oneOf.0.items.[INDEX].targetValue.textarea","typeLabel":"string | null"},"number":{"oneOf":[{"type":"number","description":"Value for number fields","uniqueKey":"rules.items.[INDEX].value_mappings.oneOf.0.items.[INDEX].targetValue.number.oneOf.0","typeLabel":"number"},{"type":"string","description":"Value for number fields","uniqueKey":"rules.items.[INDEX].value_mappings.oneOf.0.items.[INDEX].targetValue.number.oneOf.1","typeLabel":"string"},{"type":"null","description":"Value for number fields","uniqueKey":"rules.items.[INDEX].value_mappings.oneOf.0.items.[INDEX].targetValue.number.oneOf.2","typeLabel":"null"}],"uniqueKey":"rules.items.[INDEX].value_mappings.oneOf.0.items.[INDEX].targetValue.number","typeLabel":"number | string | null"},"date":{"oneOf":[{"type":"string","description":"Value for date fields (ISO 8601 date string)","uniqueKey":"rules.items.[INDEX].value_mappings.oneOf.0.items.[INDEX].targetValue.date.oneOf.0","typeLabel":"string"},{"type":"null","description":"Value for date fields (ISO 8601 date string)","uniqueKey":"rules.items.[INDEX].value_mappings.oneOf.0.items.[INDEX].targetValue.date.oneOf.1","typeLabel":"null"}],"uniqueKey":"rules.items.[INDEX].value_mappings.oneOf.0.items.[INDEX].targetValue.date","typeLabel":"string | null"},"boolean":{"oneOf":[{"type":"boolean","description":"Value for checkbox fields","uniqueKey":"rules.items.[INDEX].value_mappings.oneOf.0.items.[INDEX].targetValue.boolean.oneOf.0","typeLabel":"boolean"},{"type":"string","description":"Value for checkbox fields","uniqueKey":"rules.items.[INDEX].value_mappings.oneOf.0.items.[INDEX].targetValue.boolean.oneOf.1","typeLabel":"string"},{"type":"null","description":"Value for checkbox fields","uniqueKey":"rules.items.[INDEX].value_mappings.oneOf.0.items.[INDEX].targetValue.boolean.oneOf.2","typeLabel":"null"}],"uniqueKey":"rules.items.[INDEX].value_mappings.oneOf.0.items.[INDEX].targetValue.boolean","typeLabel":"boolean | string | null"},"select":{"oneOf":[{"type":"number","description":"Option ID for single-select fields","uniqueKey":"rules.items.[INDEX].value_mappings.oneOf.0.items.[INDEX].targetValue.select.oneOf.0","typeLabel":"number"},{"type":"null","description":"Option ID for single-select fields","uniqueKey":"rules.items.[INDEX].value_mappings.oneOf.0.items.[INDEX].targetValue.select.oneOf.1","typeLabel":"null"}],"uniqueKey":"rules.items.[INDEX].value_mappings.oneOf.0.items.[INDEX].targetValue.select","typeLabel":"number | null"},"multi_select":{"oneOf":[{"type":"array","items":{"type":"number","uniqueKey":"rules.items.[INDEX].value_mappings.oneOf.0.items.[INDEX].targetValue.multi_select.oneOf.0.items.[INDEX]","typeLabel":"number"},"description":"Option IDs for multi-select fields","uniqueKey":"rules.items.[INDEX].value_mappings.oneOf.0.items.[INDEX].targetValue.multi_select.oneOf.0","typeLabel":"number[]"},{"type":"null","description":"Option IDs for multi-select fields","uniqueKey":"rules.items.[INDEX].value_mappings.oneOf.0.items.[INDEX].targetValue.multi_select.oneOf.1","typeLabel":"null"}],"uniqueKey":"rules.items.[INDEX].value_mappings.oneOf.0.items.[INDEX].targetValue.multi_select","typeLabel":"number[] | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"rules.items.[INDEX].value_mappings.oneOf.0.items.[INDEX].targetValue","typeLabel":"object"}},"required":["sourceValue","targetValue"],"additionalProperties":false,"uniqueKey":"rules.items.[INDEX].value_mappings.oneOf.0.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"rules.items.[INDEX].value_mappings.oneOf.0","typeLabel":"object[]"},{"type":"null","isRequired":true,"uniqueKey":"rules.items.[INDEX].value_mappings.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"rules.items.[INDEX].value_mappings","typeLabel":"object[] | null"},"locked":{"type":"boolean","isRequired":true,"uniqueKey":"rules.items.[INDEX].locked","typeLabel":"boolean"}},"required":["id","label","action_type","source_field","source_values","conditions","condition_operator","target_field","target_value","value_mappings","locked"],"additionalProperties":false,"uniqueKey":"rules.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"rules","typeLabel":"object[]"},"standard_fields":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["company_name","first_name","last_name","email","phone_number","deal_name","deal_value","currency","expiration"],"description":"The built-in field. Lead fields are sent under the same name. Deal fields map to createPartnerDeal's deal_label (deal_name), deal_value, currency_code (currency) and expiration_days (expiration), and to updatePartnerDeal's fields.label and fields.expiration_date.","isRequired":true,"uniqueKey":"standard_fields.items.[INDEX].field","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","description":"Whether createPartnerLead (lead fields) or createPartnerDeal (deal fields) rejects a request without this field: 400 validation_error with reason missing_required. False means this API accepts the request without it, even when the company's own forms ask for it. Always false for a locked field (Locked + Required binds the company's own team, never a partner) and for every deal field.","isRequired":true,"uniqueKey":"standard_fields.items.[INDEX].required","typeLabel":"boolean"},"locked":{"type":"boolean","description":"Whether only the company can set this field. A partner sees its value but cannot change it: a different value returns 400 validation_error with reason locked_field; re-sending the current value is allowed. deal_value is also locked while the calling partnership's own deal value lock is on; with only that lock, createPartnerDeal ignores a sent deal_value instead of refusing it.","isRequired":true,"uniqueKey":"standard_fields.items.[INDEX].locked","typeLabel":"boolean"},"description":{"oneOf":[{"type":"string","description":"Help text the company wrote for this field, or null.","isRequired":true,"uniqueKey":"standard_fields.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Help text the company wrote for this field, or null.","isRequired":true,"uniqueKey":"standard_fields.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"standard_fields.items.[INDEX].description","typeLabel":"string | null"},"link_url":{"oneOf":[{"type":"string","description":"Optional HTTP(S) URL linked from link_label, or null.","isRequired":true,"uniqueKey":"standard_fields.items.[INDEX].link_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional HTTP(S) URL linked from link_label, or null.","isRequired":true,"uniqueKey":"standard_fields.items.[INDEX].link_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"standard_fields.items.[INDEX].link_url","typeLabel":"string | null"},"link_label":{"oneOf":[{"type":"string","description":"Optional text for the field link, or null.","isRequired":true,"uniqueKey":"standard_fields.items.[INDEX].link_label.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional text for the field link, or null.","isRequired":true,"uniqueKey":"standard_fields.items.[INDEX].link_label.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"standard_fields.items.[INDEX].link_label","typeLabel":"string | null"}},"required":["field","required","locked","description","link_url","link_label"],"additionalProperties":false,"uniqueKey":"standard_fields.items.[INDEX]","typeLabel":"object"},"description":"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.","isRequired":true,"uniqueKey":"standard_fields","typeLabel":"object[]"},"status_forms":{"description":"getPartnerLeadRequirements only: the forms a partner fills in when moving a lead to converted (Accepted) or rejected with updatePartnerLead.","type":"object","properties":{"converted":{"type":"object","properties":{"mode":{"type":"string","enum":["off","optional","required"],"description":"off: no form. optional: the fields and reason may be sent with the status change. required: required fields and a required reason must be sent with it.","isRequired":true,"uniqueKey":"status_forms.converted.mode","typeLabel":"enum\u003cstring>"},"fields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"status_forms.converted.fields.items.[INDEX].id","typeLabel":"string"},"label":{"type":"string","isRequired":true,"uniqueKey":"status_forms.converted.fields.items.[INDEX].label","typeLabel":"string"},"type":{"type":"string","enum":["text","textarea","email","website","phone","number","date","boolean","checkbox","select","multi_select","file"],"isRequired":true,"uniqueKey":"status_forms.converted.fields.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","isRequired":true,"uniqueKey":"status_forms.converted.fields.items.[INDEX].required","typeLabel":"boolean"},"options":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","isRequired":true,"uniqueKey":"status_forms.converted.fields.items.[INDEX].options.oneOf.0.items.[INDEX].id","typeLabel":"number"},"label":{"type":"string","isRequired":true,"uniqueKey":"status_forms.converted.fields.items.[INDEX].options.oneOf.0.items.[INDEX].label","typeLabel":"string"}},"required":["id","label"],"additionalProperties":false,"uniqueKey":"status_forms.converted.fields.items.[INDEX].options.oneOf.0.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"status_forms.converted.fields.items.[INDEX].options.oneOf.0","typeLabel":"object[]"},{"type":"null","isRequired":true,"uniqueKey":"status_forms.converted.fields.items.[INDEX].options.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"status_forms.converted.fields.items.[INDEX].options","typeLabel":"object[] | null"},"description":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"status_forms.converted.fields.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"status_forms.converted.fields.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"status_forms.converted.fields.items.[INDEX].description","typeLabel":"string | null"},"link_url":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"status_forms.converted.fields.items.[INDEX].link_url.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"status_forms.converted.fields.items.[INDEX].link_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"status_forms.converted.fields.items.[INDEX].link_url","typeLabel":"string | null"},"link_label":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"status_forms.converted.fields.items.[INDEX].link_label.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"status_forms.converted.fields.items.[INDEX].link_label.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"status_forms.converted.fields.items.[INDEX].link_label","typeLabel":"string | null"}},"required":["id","label","type","required","options","description","link_url","link_label"],"additionalProperties":false,"uniqueKey":"status_forms.converted.fields.items.[INDEX]","typeLabel":"object"},"description":"The form's shared fields; send their values in updatePartnerLead's custom_field_values together with the status change. `required` binds only when mode is required.","isRequired":true,"uniqueKey":"status_forms.converted.fields","typeLabel":"object[]"},"reason":{"oneOf":[{"type":"object","description":"The form's built-in reason (accepted_reason for converted, rejected_reason for rejected); null when the company hides it from partners.","required":["required"],"properties":{"required":{"type":"boolean","description":"True when the reason must be sent (mode required only).","isRequired":true,"uniqueKey":"status_forms.converted.reason.oneOf.0.required","typeLabel":"boolean"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"status_forms.converted.reason.oneOf.0","typeLabel":"object"},{"type":"null","description":"The form's built-in reason (accepted_reason for converted, rejected_reason for rejected); null when the company hides it from partners.","isRequired":true,"uniqueKey":"status_forms.converted.reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"status_forms.converted.reason","typeLabel":"object | null"}},"required":["mode","fields","reason"],"additionalProperties":false,"isRequired":true,"uniqueKey":"status_forms.converted","typeLabel":"object"},"rejected":{"type":"object","properties":{"mode":{"type":"string","enum":["off","optional","required"],"description":"off: no form. optional: the fields and reason may be sent with the status change. required: required fields and a required reason must be sent with it.","isRequired":true,"uniqueKey":"status_forms.rejected.mode","typeLabel":"enum\u003cstring>"},"fields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"status_forms.rejected.fields.items.[INDEX].id","typeLabel":"string"},"label":{"type":"string","isRequired":true,"uniqueKey":"status_forms.rejected.fields.items.[INDEX].label","typeLabel":"string"},"type":{"type":"string","enum":["text","textarea","email","website","phone","number","date","boolean","checkbox","select","multi_select","file"],"isRequired":true,"uniqueKey":"status_forms.rejected.fields.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","isRequired":true,"uniqueKey":"status_forms.rejected.fields.items.[INDEX].required","typeLabel":"boolean"},"options":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","isRequired":true,"uniqueKey":"status_forms.rejected.fields.items.[INDEX].options.oneOf.0.items.[INDEX].id","typeLabel":"number"},"label":{"type":"string","isRequired":true,"uniqueKey":"status_forms.rejected.fields.items.[INDEX].options.oneOf.0.items.[INDEX].label","typeLabel":"string"}},"required":["id","label"],"additionalProperties":false,"uniqueKey":"status_forms.rejected.fields.items.[INDEX].options.oneOf.0.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"status_forms.rejected.fields.items.[INDEX].options.oneOf.0","typeLabel":"object[]"},{"type":"null","isRequired":true,"uniqueKey":"status_forms.rejected.fields.items.[INDEX].options.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"status_forms.rejected.fields.items.[INDEX].options","typeLabel":"object[] | null"},"description":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"status_forms.rejected.fields.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"status_forms.rejected.fields.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"status_forms.rejected.fields.items.[INDEX].description","typeLabel":"string | null"},"link_url":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"status_forms.rejected.fields.items.[INDEX].link_url.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"status_forms.rejected.fields.items.[INDEX].link_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"status_forms.rejected.fields.items.[INDEX].link_url","typeLabel":"string | null"},"link_label":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"status_forms.rejected.fields.items.[INDEX].link_label.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"status_forms.rejected.fields.items.[INDEX].link_label.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"status_forms.rejected.fields.items.[INDEX].link_label","typeLabel":"string | null"}},"required":["id","label","type","required","options","description","link_url","link_label"],"additionalProperties":false,"uniqueKey":"status_forms.rejected.fields.items.[INDEX]","typeLabel":"object"},"description":"The form's shared fields; send their values in updatePartnerLead's custom_field_values together with the status change. `required` binds only when mode is required.","isRequired":true,"uniqueKey":"status_forms.rejected.fields","typeLabel":"object[]"},"reason":{"oneOf":[{"type":"object","description":"The form's built-in reason (accepted_reason for converted, rejected_reason for rejected); null when the company hides it from partners.","required":["required"],"properties":{"required":{"type":"boolean","description":"True when the reason must be sent (mode required only).","isRequired":true,"uniqueKey":"status_forms.rejected.reason.oneOf.0.required","typeLabel":"boolean"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"status_forms.rejected.reason.oneOf.0","typeLabel":"object"},{"type":"null","description":"The form's built-in reason (accepted_reason for converted, rejected_reason for rejected); null when the company hides it from partners.","isRequired":true,"uniqueKey":"status_forms.rejected.reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"status_forms.rejected.reason","typeLabel":"object | null"}},"required":["mode","fields","reason"],"additionalProperties":false,"isRequired":true,"uniqueKey":"status_forms.rejected","typeLabel":"object"}},"required":["converted","rejected"],"additionalProperties":false,"uniqueKey":"status_forms","typeLabel":"object"}},"required":["fields","rules","standard_fields"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"fields":[{"id":"\u003cstring>","label":"\u003cstring>","type":"text","required":true,"options":[{"id":123,"label":"\u003cstring>"}],"description":"\u003cstring>","link_url":"\u003cstring>","link_label":"\u003cstring>"}],"rules":[{"id":"\u003cstring>","label":"\u003cstring>","action_type":"set_value","source_field":"\u003cstring>","source_values":["\u003cstring>"],"conditions":[{"field":"\u003cstring>","values":["\u003cstring>"]}],"condition_operator":"and","target_field":"\u003cstring>","target_value":{"text":"\u003cstring>","textarea":"\u003cstring>","number":123,"date":"\u003cstring>","boolean":true,"select":123,"multi_select":[123]},"value_mappings":[{"sourceValue":"\u003cstring>","targetValue":{"text":"\u003cstring>","textarea":"\u003cstring>","number":123,"date":"\u003cstring>","boolean":true,"select":123,"multi_select":[123]}}],"locked":true}],"standard_fields":[{"field":"company_name","required":true,"locked":true,"description":"\u003cstring>","link_url":"\u003cstring>","link_label":"\u003cstring>"}],"status_forms":{"converted":{"mode":"off","fields":[{"id":"\u003cstring>","label":"\u003cstring>","type":"text","required":true,"options":[{"id":123,"label":"\u003cstring>"}],"description":"\u003cstring>","link_url":"\u003cstring>","link_label":"\u003cstring>"}],"reason":{"required":true}},"rejected":{"mode":"off","fields":[{"id":"\u003cstring>","label":"\u003cstring>","type":"text","required":true,"options":[{"id":123,"label":"\u003cstring>"}],"description":"\u003cstring>","link_url":"\u003cstring>","link_label":"\u003cstring>"}],"reason":{"required":true}}}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"ee7e257a-1749-4101-b33f-5219b49f324a":{"apiKey":{"type":"http","scheme":"bearer","description":"API key authentication. Use \"Bearer \u003capi_key>\" or \"Api-Key \u003capi_key>\".","scopes":[],"schemeName":"apiKey"}}},"servers":{"e0c483a8-4d49-4ce8-8e24-4be11d00d28b":{"url":"https://api.journeybee.io/v1","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"API key authentication. Use \"Bearer \u003capi_key>\" or \"Api-Key \u003capi_key>\".","scopes":[],"schemeName":"apiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"API key authentication. Use \"Bearer \u003capi_key>\" or \"Api-Key \u003capi_key>\".","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"apiKey","name":"Authorization"}],"title":"apiKey"}]},"originalFileLocation":"partner-openapi.json"},"subdomain":"journeybee","siteName":"Journeybee API","title":"Get lead custom field requirements - Journeybee API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-15T20:49:57.519Z","originalFileLocation":"partner-api-reference/partner/get-lead-custom-field-requirements.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns the custom fields and rules that createPartnerLead and updatePartnerLead enforce for this partnership — the fields (with their required flag) and active rules (visibility, locking, auto-population) a lead submission must satisfy — and status_forms: the shared fields and reason a status change to converted (Accepted) or rejected carries, and whether that form is off, optional or required — and standard_fields: the built-in lead fields the company shares with partners, with whether createPartnerLead rejects a request without each (required), whether it is locked, and its help text. Locked fields, which only the company can set, are never listed in fields. A rule\u0026#x27;s source_field may still name a locked field: its value appears read-only on the lead or deal record (custom_fields, with locked: true), not in fields.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Journeybee API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/journeybee/_generated/favicon/apple-touch-icon.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/journeybee/_generated/favicon/favicon-32x32.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/journeybee/_generated/favicon/favicon-16x16.png?v=3\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/journeybee/_generated/favicon/favicon.ico?v=3\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get lead custom field requirements - Journeybee API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns the custom fields and rules that createPartnerLead and updatePartnerLead enforce for this partnership — the fields (with their required flag) and active rules (visibility, locking, auto-population) a lead submission must satisfy — and status_forms: the shared fields and reason a status change to converted (Accepted) or rejected carries, and whether that form is off, optional or required — and standard_fields: the built-in lead fields the company shares with partners, with whether createPartnerLead rejects a request without each (required), whether it is locked, and its help text. Locked fields, which only the company can set, are never listed in fields. A rule\u0026#x27;s source_field may still name a locked field: its value appears read-only on the lead or deal record (custom_fields, with locked: true), not in fields.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Journeybee API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.journeybee.io/partner-api-reference/partner/get-lead-custom-field-requirements\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://journeybee.mintlify.site/_mintlify/api/og/v2?division=Partner\u0026amp;title=Get+lead+custom+field+requirements\u0026amp;description=Returns+the+custom+fields+and+rules+that+createPartnerLead+and+updatePartnerLead+enforce+for+this+partnership+%E2%80%94+the+fields+%28with+their+required+flag%29+and+active\u0026amp;theme=68f9df7cb6fc1ba2bed56275\u0026amp;signature=84525095d2d25df86c51a6d6eb64c859d4663f7ef7682d422e887a73b11d1e1d\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get lead custom field requirements - Journeybee API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns the custom fields and rules that createPartnerLead and updatePartnerLead enforce for this partnership — the fields (with their required flag) and active rules (visibility, locking, auto-population) a lead submission must satisfy — and status_forms: the shared fields and reason a status change to converted (Accepted) or rejected carries, and whether that form is off, optional or required — and standard_fields: the built-in lead fields the company shares with partners, with whether createPartnerLead rejects a request without each (required), whether it is locked, and its help text. Locked fields, which only the company can set, are never listed in fields. A rule\u0026#x27;s source_field may still name a locked field: its value appears read-only on the lead or deal record (custom_fields, with locked: true), not in fields.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://journeybee.mintlify.site/_mintlify/api/og/v2?division=Partner\u0026amp;title=Get+lead+custom+field+requirements\u0026amp;description=Returns+the+custom+fields+and+rules+that+createPartnerLead+and+updatePartnerLead+enforce+for+this+partnership+%E2%80%94+the+fields+%28with+their+required+flag%29+and+active\u0026amp;theme=68f9df7cb6fc1ba2bed56275\u0026amp;signature=84525095d2d25df86c51a6d6eb64c859d4663f7ef7682d422e887a73b11d1e1d\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"https://mintlify.s3.us-west-1.amazonaws.com/journeybee/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Journeybee API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#007aff\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.journeybee.io/partner-api-reference/partner/get-lead-custom-field-requirements\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/partner-api-reference/partner/get-lead-custom-field-requirements.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.journeybee.io/#organization\",\"name\":\"Journeybee API\",\"url\":\"https://docs.journeybee.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/journeybee/OYst47RAi-INCv0T/logo-light.svg?fit=max\u0026auto=format\u0026n=OYst47RAi-INCv0T\u0026q=85\u0026s=8afc66d3e6015e470883014b04a24784\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.journeybee.io#website\",\"name\":\"Journeybee API\",\"url\":\"https://docs.journeybee.io\",\"publisher\":{\"@id\":\"https://docs.journeybee.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.journeybee.io/partner-api-reference/partner/get-lead-custom-field-requirements#webpage\",\"url\":\"https://docs.journeybee.io/partner-api-reference/partner/get-lead-custom-field-requirements\",\"name\":\"Get lead custom field requirements\",\"description\":\"Returns the custom fields and rules that createPartnerLead and updatePartnerLead enforce for this partnership — the fields (with their required flag) and active rules (visibility, locking, auto-population) a lead submission must satisfy — and status_forms: the shared fields and reason a status change to converted (Accepted) or rejected carries, and whether that form is off, optional or required — and standard_fields: the built-in lead fields the company shares with partners, with whether createPartnerLead rejects a request without each (required), whether it is locked, and its help text. Locked fields, which only the company can set, are never listed in fields. A rule's source_field may still name a locked field: its value appears read-only on the lead or deal record (custom_fields, with locked: true), not in fields.\",\"dateModified\":\"2026-11-15T20:49:57.519Z\",\"isPartOf\":{\"@id\":\"https://docs.journeybee.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.journeybee.io/partner-api-reference/partner/get-lead-custom-field-requirements#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.journeybee.io/partner-api-reference/partner/get-lead-custom-field-requirements#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Partner API Reference\",\"item\":\"https://docs.journeybee.io/partner-api-reference/partner/get-partner-identity-and-accessible-partnerships\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Partner\",\"item\":\"https://docs.journeybee.io/partner-api-reference/partner/get-partner-identity-and-accessible-partnerships\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get lead custom field requirements\",\"item\":\"https://docs.journeybee.io/partner-api-reference/partner/get-lead-custom-field-requirements\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.journeybee.io/partner-api-reference/partner/get-lead-custom-field-requirements#apireference\",\"headline\":\"Get lead custom field requirements\",\"name\":\"Get lead custom field requirements\",\"description\":\"Returns the custom fields and rules that createPartnerLead and updatePartnerLead enforce for this partnership — the fields (with their required flag) and active rules (visibility, locking, auto-population) a lead submission must satisfy — and status_forms: the shared fields and reason a status change to converted (Accepted) or rejected carries, and whether that form is off, optional or required — and standard_fields: the built-in lead fields the company shares with partners, with whether createPartnerLead rejects a request without each (required), whether it is locked, and its help text. Locked fields, which only the company can set, are never listed in fields. A rule's source_field may still name a locked field: its value appears read-only on the lead or deal record (custom_fields, with locked: true), not in fields.\",\"url\":\"https://docs.journeybee.io/partner-api-reference/partner/get-lead-custom-field-requirements\",\"mainEntityOfPage\":{\"@id\":\"https://docs.journeybee.io/partner-api-reference/partner/get-lead-custom-field-requirements#webpage\"},\"dateModified\":\"2026-11-15T20:49:57.519Z\",\"publisher\":{\"@id\":\"https://docs.journeybee.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.journeybee.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Journeybee API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Journeybee API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/partner-api-reference/partner/get-lead-custom-field-requirements.md","siteName":"Journeybee API","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/account/get-current-account-info"}]},{"tab":"Partner API","groups":[{"group":"Guides","pages":[{"title":"Partner API","href":"/guides/partner-api"},{"title":"Partner MCP","href":"/guides/partner-mcp"}]},{"group":"Partner API Reference","pages":[{"group":"Partner","pages":[{"title":"Get partner identity and accessible partnerships","deprecated":null,"version":null,"openapi":"/partner-openapi.json get /partner/me","href":"/partner-api-reference/partner/get-partner-identity-and-accessible-partnerships"},{"title":"List partnership leads","deprecated":null,"version":null,"openapi":"/partner-openapi.json get /partner/{partnershipId}/leads","href":"/partner-api-reference/partner/list-partnership-leads"},{"title":"Create a partnership lead","description":"Custom fields may be required or rule-controlled — call getPartnerLeadRequirements first to learn the field/rule constraints. Validation failures return per-field `details` with machine-readable `reason` codes. A lead field the vendor does not share with partners (`first_name`, `last_name`, `email` or `phone_number`) cannot be set: a non-empty value returns 400 `validation_error` with reason `hidden_by_rule` and nothing is saved. A lead field the vendor has locked (getPartnerLeadRequirements `standard_fields` with `locked: true`) is set only by the vendor: a non-empty value returns 400 `validation_error` with reason `locked_field` and nothing is saved, and a locked field is never required from a partner.","deprecated":null,"version":null,"openapi":"/partner-openapi.json post /partner/{partnershipId}/leads","href":"/partner-api-reference/partner/create-a-partnership-lead"},{"title":"Get lead custom field requirements","deprecated":null,"version":null,"openapi":"/partner-openapi.json get /partner/{partnershipId}/leads/requirements","href":"/partner-api-reference/partner/get-lead-custom-field-requirements"},{"title":"Get a partnership lead","description":null,"deprecated":null,"version":null,"openapi":"/partner-openapi.json get /partner/{partnershipId}/leads/{leadId}","href":"/partner-api-reference/partner/get-a-partnership-lead"},{"title":"Update a partnership lead","deprecated":null,"version":null,"openapi":"/partner-openapi.json patch /partner/{partnershipId}/leads/{leadId}","href":"/partner-api-reference/partner/update-a-partnership-lead"},{"title":"List partnership deals","deprecated":null,"version":null,"openapi":"/partner-openapi.json get /partner/{partnershipId}/deals","href":"/partner-api-reference/partner/list-partnership-deals"},{"title":"Create a partnership deal","deprecated":null,"version":null,"openapi":"/partner-openapi.json post /partner/{partnershipId}/deals","href":"/partner-api-reference/partner/create-a-partnership-deal"},{"title":"Get deal custom field requirements","deprecated":null,"version":null,"openapi":"/partner-openapi.json get /partner/{partnershipId}/deals/requirements","href":"/partner-api-reference/partner/get-deal-custom-field-requirements"},{"title":"Get a partnership deal","deprecated":null,"version":null,"openapi":"/partner-openapi.json get /partner/{partnershipId}/deals/{dealId}","href":"/partner-api-reference/partner/get-a-partnership-deal"},{"title":"Update a partnership deal","deprecated":null,"version":null,"openapi":"/partner-openapi.json patch /partner/{partnershipId}/deals/{dealId}","href":"/partner-api-reference/partner/update-a-partnership-deal"}]}]}]}]},"basePath":"","title":"Get lead custom field requirements - Journeybee API","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DdEMm2kG.js","utils-BMo572L7.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C-4m9KAx.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DPLK2Oq9.js","snippetPresets-BKjfJMC9.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DTsgtCEj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C8vmhyQM.js","shallow-r9w8LQGS.js","getApiPlaygroundDisplay-DjPI64HQ.js","CodeSnippet-C8Bvhl16.js","CodeSnippets-BtWUwcMy.js","Page-BIYvYBgk.js","getPastedJson-Dcm_3Pgl.js","icon-BXwrTpjc.js","MethodPill-CcjfVmmy.js","DuplicateIcon-BuKIbXAQ.js","createIcon-DaL9yXsO.js","DynamicMarkdown-Co5nikxh.js","SectionHeading-P4UNTsMZ.js","axios-vUo_bRtp.js","Markdown-CEfymfIH.js","clsx-Dq9TQuNi.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-D2J8knkn.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BgZ2ThuU.js"]}