{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"NLPearl Documentation","colors":{"primary":"#111111","light":"#F7F7F7","dark":"#111111"},"logo":{"light":"https://mintcdn.com/nlpearl/DSJnNLmkdffV1qq-/images/light_mode/logo_dark.png?fit=max\u0026auto=format\u0026n=DSJnNLmkdffV1qq-\u0026q=85\u0026s=a0f34eb8d06f12c8f03693ffc4dfffeb","dark":"https://mintcdn.com/nlpearl/OLkkXJCUYovrG0y1/images/dark_mode/logo_white.png?fit=max\u0026auto=format\u0026n=OLkkXJCUYovrG0y1\u0026q=85\u0026s=ca1df5c71744266b64671933f827dfa0"},"favicon":"https://mintcdn.com/nlpearl/yjNN1PpSs3yxoZOQ/logo/NLPearlPhoneBlack.png?fit=max\u0026auto=format\u0026n=yjNN1PpSs3yxoZOQ\u0026q=85\u0026s=e3e03483b2f74c5695aba247785b4980","background":{"color":{"dark":"#1A1A19"}},"fonts":{"family":"Roboto"},"banner":{"content":"🎙️ Pearl TTS is now live! [Turn text into speech](/pages/voice_studio) and clone your own voice in Voice Studio.","dismissible":true},"contextual":{"options":["copy","view","chatgpt","claude","cursor"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"nlpearl","hasAudioNarration":false,"actualSubdomain":"nlpearl","customDomains":["developers.nlpearl.ai"],"gitSource":{"type":"github","owner":"nlpearldev","repo":"nlpearldocumentation","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aea23efbe4973f62cf42c4e","collectionId":"d2d719ee-921a-4cc2-ad6a-a9f53e90e573","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aea23efbe4973f62cf42c4e"},"entitlements":{},"buildId":"6aea23efbe4973f62cf42c4e","clientVersion":"0.0.4054","searchFilterCounts":[{"language":"default","tag":"API Reference","count":81},{"language":"default","tag":"API V2","count":50},{"language":"default","tag":"Docs","count":48},{"language":"default","tag":"API V1","count":26},{"language":"default","tag":"Outbound","count":25},{"language":"default","tag":"Pearl Configurations","count":20},{"language":"default","tag":"Pearl Voice","count":16},{"language":"default","tag":"General","count":13},{"language":"default","tag":"Pearl Text","count":11},{"language":"default","tag":"Account","count":10}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","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":"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":"llms-txt-v2","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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"sso-setup-deadline-banner","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}],"googleFontsInlined":true},"customCss":[{"filePath":"css/custom.css","content":"a[href=\"https://platform.nlpearl.ai/\"]{transition:color .3s ease,fill .3s ease}a[href=\"https://platform.nlpearl.ai/\"]:hover{color:#006ffe}a[href=\"https://platform.nlpearl.ai/\"]:hover svg,a[href=\"https://platform.nlpearl.ai/\"]:hover svg path{fill:#1620aa!important}[class*=max-w-xl][class*=grow],[class*=max-w-xl][class*=max-w-2xl]{max-width:48rem!important}:root{--content-width:48rem}a.nav-tabs-item[href*=api-reference]{color:#2dbe73!important;font-weight:600!important}a.nav-tabs-item[href*=api-reference]:hover,a.nav-tabs-item[href*=api-reference][class*=text-shadow]{color:#2dbe73!important}.dark a.nav-tabs-item[href*=api-reference][class*=text-shadow]{color:#fff!important}.prose :where(thead th):not(:where([class~=not-prose],[class~=not-prose] *)){color:#a1a1a1;text-align:left}.prose :where(table):not(:where([class~=not-prose],[class~=not-prose] *)){display:table}.dark #content-area div.mdx-content .prose li,.dark #content-area div.mdx-content .prose span[data-as=p],.dark #content-area div.mdx-content .prose td,.dark #content-area div.mdx-content.prose li,.dark #content-area div.mdx-content.prose td,.dark #content-area div.mdx-content.prose>span[data-as=p]{color:#c8c8c8!important}.dark #content-area div.mdx-content .callout li,.dark #content-area div.mdx-content .callout p,.dark #content-area div.mdx-content .callout span,.dark #content-area div.mdx-content .callout span[data-as=p],.dark #content-area div.mdx-content .callout td{color:inherit!important}details.accordion{background-color:rgba(255,255,255,.025)!important}details.accordion>summary{padding:13px 12px!important;transition:background-color .2s ease}details.accordion>summary:hover{background-color:rgba(255,255,255,.05)!important}details.accordion p[data-component-part=accordion-title]{font-size:.9rem!important}.accordion-group,details.accordion{border-color:rgba(255,255,255,.08)!important}.accordion-group>details{border-color:rgba(255,255,255,.06)!important}#banner{background-color:#1f1f1f!important}:root[class~=dark]{--background:60 2% 10%!important;--background-dark:26 26 25!important}"}],"page":{"pagePath":"api-reference/v2/outbound/add-leads","slug":"/api-reference/v2/outbound/add-leads","pageMetadata":{"openapi":"post /v2/Outbound/{pearlId}/Leads/Add","title":"Add Leads","description":"Adds new leads to a specified outbound","href":"/api-reference/v2/outbound/add-leads"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Adds new leads to a specified outbound\"\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":{"openapi":"post /v2/Outbound/{pearlId}/Leads/Add","title":"Add Leads","description":"Adds new leads to a specified outbound","href":"/api-reference/v2/outbound/add-leads"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Outbound"],"summary":"Add Leads","description":"Adds new leads to a specified outbound","parameters":["9279f035-42eb-4cb4-adc7-bfc196b3a211"],"requestBody":"93e5e869-21ab-4fbd-a63e-7128646c829f","responses":{"200":"272dcc9a-6e98-4a6d-b995-abb7ca5c2cb9","400":"22de97e3-423d-4d23-8344-eb2a41def04e"},"method":"post","type":"path","servers":["97fe3b36-7240-450a-91db-08f0f513c5ca"],"security":["d10e24f8-f72b-42cb-89ba-7d212b24326e","fe39eb34-84be-4ead-9434-f64ad29ef824"],"path":"/v2/Outbound/{pearlId}/Leads/Add","baseUrlOptions":["https://api.nlpearl.ai"],"title":"Add Leads","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"9279f035-42eb-4cb4-adc7-bfc196b3a211":{"name":"pearlId","in":"path","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"leads":{"oneOf":[{"type":"array","items":{"required":["phoneNumber"],"type":"object","properties":{"phoneNumber":{"minLength":1,"type":"string","description":"The phone number of the lead.","isRequired":true,"uniqueKey":"leads.oneOf.0.items.[INDEX].phoneNumber","typeLabel":"string"},"externalId":{"oneOf":[{"type":"string","description":"An optional external identifier for the lead.","uniqueKey":"leads.oneOf.0.items.[INDEX].externalId.oneOf.0","typeLabel":"string"},{"type":"null","description":"An optional external identifier for the lead.","uniqueKey":"leads.oneOf.0.items.[INDEX].externalId.oneOf.1","typeLabel":"null"}],"uniqueKey":"leads.oneOf.0.items.[INDEX].externalId","typeLabel":"string | null"},"timeZoneId":{"oneOf":[{"type":"string","description":"Optional time zone identifier for the lead. \r\nIf provided, this will override the default time zone configured at the outbound level. \r\nBy default, an outbound campaign has a predefined time zone (set during creation or modified later on the platform), \r\nbut you can assign a specific time zone to a lead by specifying this property. \r\n\r\nIf not provided, the lead will use the outbound's default time zone. \r\n\r\nFor valid values, refer to the \"TimeZone\" column in the following list: \r\n[Time Zone List](https://learn.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11) \r\n\r\nExamples: `\"Pacific Standard Time\"`, `\"Türkiye Standard Time\"`","uniqueKey":"leads.oneOf.0.items.[INDEX].timeZoneId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional time zone identifier for the lead. \r\nIf provided, this will override the default time zone configured at the outbound level. \r\nBy default, an outbound campaign has a predefined time zone (set during creation or modified later on the platform), \r\nbut you can assign a specific time zone to a lead by specifying this property. \r\n\r\nIf not provided, the lead will use the outbound's default time zone. \r\n\r\nFor valid values, refer to the \"TimeZone\" column in the following list: \r\n[Time Zone List](https://learn.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11) \r\n\r\nExamples: `\"Pacific Standard Time\"`, `\"Türkiye Standard Time\"`","uniqueKey":"leads.oneOf.0.items.[INDEX].timeZoneId.oneOf.1","typeLabel":"null"}],"uniqueKey":"leads.oneOf.0.items.[INDEX].timeZoneId","typeLabel":"string | null"},"callData":{"oneOf":[{"type":"object","additionalProperties":{"type":"string","uniqueKey":"leads.oneOf.0.items.[INDEX].callData.oneOf.0.additionalProperties","typeLabel":"string"},"description":"A dictionary containing additional information about the call.\r\nIt is used as variables that you can use in \"Opening Sentence\" or \"Flow Script\" when you create a Pearl on the platform.\r\nThe keys represent the field names, and the values contain the corresponding data.\r\nThis information can be used to personalize the conversation or manage lead-specific details.\r\nThis parameter is optional.\r\n\r\nSee [Variables](/pages/variables) for more information.\r\nHere is an example of the json to send:\r\n\r\n`{ \"email\" : \"joe@gmail.com\", \"address\": \"3 Abbey Road UK\" , \"carLicense\" : \"90-929-82\" }`","uniqueKey":"leads.oneOf.0.items.[INDEX].callData.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"string","uniqueKey":"leads.oneOf.0.items.[INDEX].callData.oneOf.1.additionalProperties","typeLabel":"string"},"description":"A dictionary containing additional information about the call.\r\nIt is used as variables that you can use in \"Opening Sentence\" or \"Flow Script\" when you create a Pearl on the platform.\r\nThe keys represent the field names, and the values contain the corresponding data.\r\nThis information can be used to personalize the conversation or manage lead-specific details.\r\nThis parameter is optional.\r\n\r\nSee [Variables](/pages/variables) for more information.\r\nHere is an example of the json to send:\r\n\r\n`{ \"email\" : \"joe@gmail.com\", \"address\": \"3 Abbey Road UK\" , \"carLicense\" : \"90-929-82\" }`","uniqueKey":"leads.oneOf.0.items.[INDEX].callData.oneOf.1","typeLabel":"null"}],"uniqueKey":"leads.oneOf.0.items.[INDEX].callData","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"leads.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Collection of leads to add to an outbound Pearl.\r\n \r\nConstraints:\r\n- Max 50,000 leads.\r\n- Each lead must follow the validation rules defined in LeadToAddApi.","uniqueKey":"leads.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"required":["phoneNumber"],"type":"object","properties":{"phoneNumber":{"minLength":1,"type":"string","description":"The phone number of the lead."},"externalId":{"oneOf":[{"type":"string","description":"An optional external identifier for the lead."},{"type":"null","description":"An optional external identifier for the lead."}]},"timeZoneId":{"oneOf":[{"type":"string","description":"Optional time zone identifier for the lead. \r\nIf provided, this will override the default time zone configured at the outbound level. \r\nBy default, an outbound campaign has a predefined time zone (set during creation or modified later on the platform), \r\nbut you can assign a specific time zone to a lead by specifying this property. \r\n\r\nIf not provided, the lead will use the outbound's default time zone. \r\n\r\nFor valid values, refer to the \"TimeZone\" column in the following list: \r\n[Time Zone List](https://learn.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11) \r\n\r\nExamples: `\"Pacific Standard Time\"`, `\"Türkiye Standard Time\"`"},{"type":"null","description":"Optional time zone identifier for the lead. \r\nIf provided, this will override the default time zone configured at the outbound level. \r\nBy default, an outbound campaign has a predefined time zone (set during creation or modified later on the platform), \r\nbut you can assign a specific time zone to a lead by specifying this property. \r\n\r\nIf not provided, the lead will use the outbound's default time zone. \r\n\r\nFor valid values, refer to the \"TimeZone\" column in the following list: \r\n[Time Zone List](https://learn.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11) \r\n\r\nExamples: `\"Pacific Standard Time\"`, `\"Türkiye Standard Time\"`"}]},"callData":{"oneOf":[{"type":"object","additionalProperties":{"type":"string"},"description":"A dictionary containing additional information about the call.\r\nIt is used as variables that you can use in \"Opening Sentence\" or \"Flow Script\" when you create a Pearl on the platform.\r\nThe keys represent the field names, and the values contain the corresponding data.\r\nThis information can be used to personalize the conversation or manage lead-specific details.\r\nThis parameter is optional.\r\n\r\nSee [Variables](/pages/variables) for more information.\r\nHere is an example of the json to send:\r\n\r\n`{ \"email\" : \"joe@gmail.com\", \"address\": \"3 Abbey Road UK\" , \"carLicense\" : \"90-929-82\" }`"},{"type":"null","additionalProperties":{"type":"string"},"description":"A dictionary containing additional information about the call.\r\nIt is used as variables that you can use in \"Opening Sentence\" or \"Flow Script\" when you create a Pearl on the platform.\r\nThe keys represent the field names, and the values contain the corresponding data.\r\nThis information can be used to personalize the conversation or manage lead-specific details.\r\nThis parameter is optional.\r\n\r\nSee [Variables](/pages/variables) for more information.\r\nHere is an example of the json to send:\r\n\r\n`{ \"email\" : \"joe@gmail.com\", \"address\": \"3 Abbey Road UK\" , \"carLicense\" : \"90-929-82\" }`"}]}},"additionalProperties":false},"description":"Collection of leads to add to an outbound Pearl.\r\n \r\nConstraints:\r\n- Max 50,000 leads.\r\n- Each lead must follow the validation rules defined in LeadToAddApi.","uniqueKey":"leads.oneOf.1","typeLabel":"null"}],"uniqueKey":"leads","typeLabel":"object[] | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"leads":[{"phoneNumber":"\u003cstring>","externalId":"\u003cstring>","timeZoneId":"\u003cstring>","callData":{}}]}}},"exampleType":"generated"},"text/json":{"schema":{"type":"object","properties":{"leads":{"oneOf":[{"type":"array","items":{"required":["phoneNumber"],"type":"object","properties":{"phoneNumber":{"minLength":1,"type":"string","description":"The phone number of the lead.","isRequired":true,"uniqueKey":"leads.oneOf.0.items.[INDEX].phoneNumber","typeLabel":"string"},"externalId":{"oneOf":[{"type":"string","description":"An optional external identifier for the lead.","uniqueKey":"leads.oneOf.0.items.[INDEX].externalId.oneOf.0","typeLabel":"string"},{"type":"null","description":"An optional external identifier for the lead.","uniqueKey":"leads.oneOf.0.items.[INDEX].externalId.oneOf.1","typeLabel":"null"}],"uniqueKey":"leads.oneOf.0.items.[INDEX].externalId","typeLabel":"string | null"},"timeZoneId":{"oneOf":[{"type":"string","description":"Optional time zone identifier for the lead. \r\nIf provided, this will override the default time zone configured at the outbound level. \r\nBy default, an outbound campaign has a predefined time zone (set during creation or modified later on the platform), \r\nbut you can assign a specific time zone to a lead by specifying this property. \r\n\r\nIf not provided, the lead will use the outbound's default time zone. \r\n\r\nFor valid values, refer to the \"TimeZone\" column in the following list: \r\n[Time Zone List](https://learn.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11) \r\n\r\nExamples: `\"Pacific Standard Time\"`, `\"Türkiye Standard Time\"`","uniqueKey":"leads.oneOf.0.items.[INDEX].timeZoneId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional time zone identifier for the lead. \r\nIf provided, this will override the default time zone configured at the outbound level. \r\nBy default, an outbound campaign has a predefined time zone (set during creation or modified later on the platform), \r\nbut you can assign a specific time zone to a lead by specifying this property. \r\n\r\nIf not provided, the lead will use the outbound's default time zone. \r\n\r\nFor valid values, refer to the \"TimeZone\" column in the following list: \r\n[Time Zone List](https://learn.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11) \r\n\r\nExamples: `\"Pacific Standard Time\"`, `\"Türkiye Standard Time\"`","uniqueKey":"leads.oneOf.0.items.[INDEX].timeZoneId.oneOf.1","typeLabel":"null"}],"uniqueKey":"leads.oneOf.0.items.[INDEX].timeZoneId","typeLabel":"string | null"},"callData":{"oneOf":[{"type":"object","additionalProperties":{"type":"string","uniqueKey":"leads.oneOf.0.items.[INDEX].callData.oneOf.0.additionalProperties","typeLabel":"string"},"description":"A dictionary containing additional information about the call.\r\nIt is used as variables that you can use in \"Opening Sentence\" or \"Flow Script\" when you create a Pearl on the platform.\r\nThe keys represent the field names, and the values contain the corresponding data.\r\nThis information can be used to personalize the conversation or manage lead-specific details.\r\nThis parameter is optional.\r\n\r\nSee [Variables](/pages/variables) for more information.\r\nHere is an example of the json to send:\r\n\r\n`{ \"email\" : \"joe@gmail.com\", \"address\": \"3 Abbey Road UK\" , \"carLicense\" : \"90-929-82\" }`","uniqueKey":"leads.oneOf.0.items.[INDEX].callData.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"string","uniqueKey":"leads.oneOf.0.items.[INDEX].callData.oneOf.1.additionalProperties","typeLabel":"string"},"description":"A dictionary containing additional information about the call.\r\nIt is used as variables that you can use in \"Opening Sentence\" or \"Flow Script\" when you create a Pearl on the platform.\r\nThe keys represent the field names, and the values contain the corresponding data.\r\nThis information can be used to personalize the conversation or manage lead-specific details.\r\nThis parameter is optional.\r\n\r\nSee [Variables](/pages/variables) for more information.\r\nHere is an example of the json to send:\r\n\r\n`{ \"email\" : \"joe@gmail.com\", \"address\": \"3 Abbey Road UK\" , \"carLicense\" : \"90-929-82\" }`","uniqueKey":"leads.oneOf.0.items.[INDEX].callData.oneOf.1","typeLabel":"null"}],"uniqueKey":"leads.oneOf.0.items.[INDEX].callData","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"leads.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Collection of leads to add to an outbound Pearl.\r\n \r\nConstraints:\r\n- Max 50,000 leads.\r\n- Each lead must follow the validation rules defined in LeadToAddApi.","uniqueKey":"leads.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"required":["phoneNumber"],"type":"object","properties":{"phoneNumber":{"minLength":1,"type":"string","description":"The phone number of the lead."},"externalId":{"oneOf":[{"type":"string","description":"An optional external identifier for the lead."},{"type":"null","description":"An optional external identifier for the lead."}]},"timeZoneId":{"oneOf":[{"type":"string","description":"Optional time zone identifier for the lead. \r\nIf provided, this will override the default time zone configured at the outbound level. \r\nBy default, an outbound campaign has a predefined time zone (set during creation or modified later on the platform), \r\nbut you can assign a specific time zone to a lead by specifying this property. \r\n\r\nIf not provided, the lead will use the outbound's default time zone. \r\n\r\nFor valid values, refer to the \"TimeZone\" column in the following list: \r\n[Time Zone List](https://learn.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11) \r\n\r\nExamples: `\"Pacific Standard Time\"`, `\"Türkiye Standard Time\"`"},{"type":"null","description":"Optional time zone identifier for the lead. \r\nIf provided, this will override the default time zone configured at the outbound level. \r\nBy default, an outbound campaign has a predefined time zone (set during creation or modified later on the platform), \r\nbut you can assign a specific time zone to a lead by specifying this property. \r\n\r\nIf not provided, the lead will use the outbound's default time zone. \r\n\r\nFor valid values, refer to the \"TimeZone\" column in the following list: \r\n[Time Zone List](https://learn.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11) \r\n\r\nExamples: `\"Pacific Standard Time\"`, `\"Türkiye Standard Time\"`"}]},"callData":{"oneOf":[{"type":"object","additionalProperties":{"type":"string"},"description":"A dictionary containing additional information about the call.\r\nIt is used as variables that you can use in \"Opening Sentence\" or \"Flow Script\" when you create a Pearl on the platform.\r\nThe keys represent the field names, and the values contain the corresponding data.\r\nThis information can be used to personalize the conversation or manage lead-specific details.\r\nThis parameter is optional.\r\n\r\nSee [Variables](/pages/variables) for more information.\r\nHere is an example of the json to send:\r\n\r\n`{ \"email\" : \"joe@gmail.com\", \"address\": \"3 Abbey Road UK\" , \"carLicense\" : \"90-929-82\" }`"},{"type":"null","additionalProperties":{"type":"string"},"description":"A dictionary containing additional information about the call.\r\nIt is used as variables that you can use in \"Opening Sentence\" or \"Flow Script\" when you create a Pearl on the platform.\r\nThe keys represent the field names, and the values contain the corresponding data.\r\nThis information can be used to personalize the conversation or manage lead-specific details.\r\nThis parameter is optional.\r\n\r\nSee [Variables](/pages/variables) for more information.\r\nHere is an example of the json to send:\r\n\r\n`{ \"email\" : \"joe@gmail.com\", \"address\": \"3 Abbey Road UK\" , \"carLicense\" : \"90-929-82\" }`"}]}},"additionalProperties":false},"description":"Collection of leads to add to an outbound Pearl.\r\n \r\nConstraints:\r\n- Max 50,000 leads.\r\n- Each lead must follow the validation rules defined in LeadToAddApi.","uniqueKey":"leads.oneOf.1","typeLabel":"null"}],"uniqueKey":"leads","typeLabel":"object[] | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"leads":[{"phoneNumber":"\u003cstring>","externalId":"\u003cstring>","timeZoneId":"\u003cstring>","callData":{}}]}}},"exampleType":"generated"},"application/*+json":{"schema":{"type":"object","properties":{"leads":{"oneOf":[{"type":"array","items":{"required":["phoneNumber"],"type":"object","properties":{"phoneNumber":{"minLength":1,"type":"string","description":"The phone number of the lead.","isRequired":true,"uniqueKey":"leads.oneOf.0.items.[INDEX].phoneNumber","typeLabel":"string"},"externalId":{"oneOf":[{"type":"string","description":"An optional external identifier for the lead.","uniqueKey":"leads.oneOf.0.items.[INDEX].externalId.oneOf.0","typeLabel":"string"},{"type":"null","description":"An optional external identifier for the lead.","uniqueKey":"leads.oneOf.0.items.[INDEX].externalId.oneOf.1","typeLabel":"null"}],"uniqueKey":"leads.oneOf.0.items.[INDEX].externalId","typeLabel":"string | null"},"timeZoneId":{"oneOf":[{"type":"string","description":"Optional time zone identifier for the lead. \r\nIf provided, this will override the default time zone configured at the outbound level. \r\nBy default, an outbound campaign has a predefined time zone (set during creation or modified later on the platform), \r\nbut you can assign a specific time zone to a lead by specifying this property. \r\n\r\nIf not provided, the lead will use the outbound's default time zone. \r\n\r\nFor valid values, refer to the \"TimeZone\" column in the following list: \r\n[Time Zone List](https://learn.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11) \r\n\r\nExamples: `\"Pacific Standard Time\"`, `\"Türkiye Standard Time\"`","uniqueKey":"leads.oneOf.0.items.[INDEX].timeZoneId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional time zone identifier for the lead. \r\nIf provided, this will override the default time zone configured at the outbound level. \r\nBy default, an outbound campaign has a predefined time zone (set during creation or modified later on the platform), \r\nbut you can assign a specific time zone to a lead by specifying this property. \r\n\r\nIf not provided, the lead will use the outbound's default time zone. \r\n\r\nFor valid values, refer to the \"TimeZone\" column in the following list: \r\n[Time Zone List](https://learn.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11) \r\n\r\nExamples: `\"Pacific Standard Time\"`, `\"Türkiye Standard Time\"`","uniqueKey":"leads.oneOf.0.items.[INDEX].timeZoneId.oneOf.1","typeLabel":"null"}],"uniqueKey":"leads.oneOf.0.items.[INDEX].timeZoneId","typeLabel":"string | null"},"callData":{"oneOf":[{"type":"object","additionalProperties":{"type":"string","uniqueKey":"leads.oneOf.0.items.[INDEX].callData.oneOf.0.additionalProperties","typeLabel":"string"},"description":"A dictionary containing additional information about the call.\r\nIt is used as variables that you can use in \"Opening Sentence\" or \"Flow Script\" when you create a Pearl on the platform.\r\nThe keys represent the field names, and the values contain the corresponding data.\r\nThis information can be used to personalize the conversation or manage lead-specific details.\r\nThis parameter is optional.\r\n\r\nSee [Variables](/pages/variables) for more information.\r\nHere is an example of the json to send:\r\n\r\n`{ \"email\" : \"joe@gmail.com\", \"address\": \"3 Abbey Road UK\" , \"carLicense\" : \"90-929-82\" }`","uniqueKey":"leads.oneOf.0.items.[INDEX].callData.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"string","uniqueKey":"leads.oneOf.0.items.[INDEX].callData.oneOf.1.additionalProperties","typeLabel":"string"},"description":"A dictionary containing additional information about the call.\r\nIt is used as variables that you can use in \"Opening Sentence\" or \"Flow Script\" when you create a Pearl on the platform.\r\nThe keys represent the field names, and the values contain the corresponding data.\r\nThis information can be used to personalize the conversation or manage lead-specific details.\r\nThis parameter is optional.\r\n\r\nSee [Variables](/pages/variables) for more information.\r\nHere is an example of the json to send:\r\n\r\n`{ \"email\" : \"joe@gmail.com\", \"address\": \"3 Abbey Road UK\" , \"carLicense\" : \"90-929-82\" }`","uniqueKey":"leads.oneOf.0.items.[INDEX].callData.oneOf.1","typeLabel":"null"}],"uniqueKey":"leads.oneOf.0.items.[INDEX].callData","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"leads.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Collection of leads to add to an outbound Pearl.\r\n \r\nConstraints:\r\n- Max 50,000 leads.\r\n- Each lead must follow the validation rules defined in LeadToAddApi.","uniqueKey":"leads.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"required":["phoneNumber"],"type":"object","properties":{"phoneNumber":{"minLength":1,"type":"string","description":"The phone number of the lead."},"externalId":{"oneOf":[{"type":"string","description":"An optional external identifier for the lead."},{"type":"null","description":"An optional external identifier for the lead."}]},"timeZoneId":{"oneOf":[{"type":"string","description":"Optional time zone identifier for the lead. \r\nIf provided, this will override the default time zone configured at the outbound level. \r\nBy default, an outbound campaign has a predefined time zone (set during creation or modified later on the platform), \r\nbut you can assign a specific time zone to a lead by specifying this property. \r\n\r\nIf not provided, the lead will use the outbound's default time zone. \r\n\r\nFor valid values, refer to the \"TimeZone\" column in the following list: \r\n[Time Zone List](https://learn.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11) \r\n\r\nExamples: `\"Pacific Standard Time\"`, `\"Türkiye Standard Time\"`"},{"type":"null","description":"Optional time zone identifier for the lead. \r\nIf provided, this will override the default time zone configured at the outbound level. \r\nBy default, an outbound campaign has a predefined time zone (set during creation or modified later on the platform), \r\nbut you can assign a specific time zone to a lead by specifying this property. \r\n\r\nIf not provided, the lead will use the outbound's default time zone. \r\n\r\nFor valid values, refer to the \"TimeZone\" column in the following list: \r\n[Time Zone List](https://learn.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11) \r\n\r\nExamples: `\"Pacific Standard Time\"`, `\"Türkiye Standard Time\"`"}]},"callData":{"oneOf":[{"type":"object","additionalProperties":{"type":"string"},"description":"A dictionary containing additional information about the call.\r\nIt is used as variables that you can use in \"Opening Sentence\" or \"Flow Script\" when you create a Pearl on the platform.\r\nThe keys represent the field names, and the values contain the corresponding data.\r\nThis information can be used to personalize the conversation or manage lead-specific details.\r\nThis parameter is optional.\r\n\r\nSee [Variables](/pages/variables) for more information.\r\nHere is an example of the json to send:\r\n\r\n`{ \"email\" : \"joe@gmail.com\", \"address\": \"3 Abbey Road UK\" , \"carLicense\" : \"90-929-82\" }`"},{"type":"null","additionalProperties":{"type":"string"},"description":"A dictionary containing additional information about the call.\r\nIt is used as variables that you can use in \"Opening Sentence\" or \"Flow Script\" when you create a Pearl on the platform.\r\nThe keys represent the field names, and the values contain the corresponding data.\r\nThis information can be used to personalize the conversation or manage lead-specific details.\r\nThis parameter is optional.\r\n\r\nSee [Variables](/pages/variables) for more information.\r\nHere is an example of the json to send:\r\n\r\n`{ \"email\" : \"joe@gmail.com\", \"address\": \"3 Abbey Road UK\" , \"carLicense\" : \"90-929-82\" }`"}]}},"additionalProperties":false},"description":"Collection of leads to add to an outbound Pearl.\r\n \r\nConstraints:\r\n- Max 50,000 leads.\r\n- Each lead must follow the validation rules defined in LeadToAddApi.","uniqueKey":"leads.oneOf.1","typeLabel":"null"}],"uniqueKey":"leads","typeLabel":"object[] | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"leads":[{"phoneNumber":"\u003cstring>","externalId":"\u003cstring>","timeZoneId":"\u003cstring>","callData":{}}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"272dcc9a-6e98-4a6d-b995-abb7ca5c2cb9":{"description":"All leads were added successfully.","content":{"text/plain":{"schema":{"type":"boolean","uniqueKey":"","typeLabel":"boolean"},"examples":{"Example":{"title":"Example","value":true}},"exampleType":"generated"},"application/json":{"schema":{"type":"boolean","uniqueKey":"","typeLabel":"boolean"},"examples":{"Example":{"title":"Example","value":true}},"exampleType":"generated"},"text/json":{"schema":{"type":"boolean","uniqueKey":"","typeLabel":"boolean"},"examples":{"Example":{"title":"Example","value":true}},"exampleType":"generated"}},"exampleType":"generated"},"22de97e3-423d-4d23-8344-eb2a41def04e":{"description":"The request is invalid or some leads could not be added. The response may contain validation errors or a list of failed leads with their associated errors.","content":{"text/plain":{"schema":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","uniqueKey":"type.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"type.oneOf.1","typeLabel":"null"}],"uniqueKey":"type","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","uniqueKey":"title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"title.oneOf.1","typeLabel":"null"}],"uniqueKey":"title","typeLabel":"string | null"},"status":{"oneOf":[{"type":"integer","format":"int32","uniqueKey":"status.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","uniqueKey":"status.oneOf.1","typeLabel":"null"}],"uniqueKey":"status","typeLabel":"integer\u003cint32> | null"},"detail":{"oneOf":[{"type":"string","uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail","typeLabel":"string | null"},"instance":{"oneOf":[{"type":"string","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"},"errors":{"oneOf":[{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"errors.oneOf.0.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.oneOf.0.additionalProperties","typeLabel":"string[]"},"uniqueKey":"errors.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"errors.oneOf.1.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.oneOf.1.additionalProperties","typeLabel":"string[]"},"uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"object | null"}},"additionalProperties":{"oneOf":[{}],"uniqueKey":"additionalProperties","typeLabel":"any"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>","errors":{}}}},"exampleType":"generated"},"application/json":{"schema":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","uniqueKey":"type.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"type.oneOf.1","typeLabel":"null"}],"uniqueKey":"type","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","uniqueKey":"title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"title.oneOf.1","typeLabel":"null"}],"uniqueKey":"title","typeLabel":"string | null"},"status":{"oneOf":[{"type":"integer","format":"int32","uniqueKey":"status.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","uniqueKey":"status.oneOf.1","typeLabel":"null"}],"uniqueKey":"status","typeLabel":"integer\u003cint32> | null"},"detail":{"oneOf":[{"type":"string","uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail","typeLabel":"string | null"},"instance":{"oneOf":[{"type":"string","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"},"errors":{"oneOf":[{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"errors.oneOf.0.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.oneOf.0.additionalProperties","typeLabel":"string[]"},"uniqueKey":"errors.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"errors.oneOf.1.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.oneOf.1.additionalProperties","typeLabel":"string[]"},"uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"object | null"}},"additionalProperties":{"oneOf":[{}],"uniqueKey":"additionalProperties","typeLabel":"any"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>","errors":{}}}},"exampleType":"generated"},"text/json":{"schema":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","uniqueKey":"type.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"type.oneOf.1","typeLabel":"null"}],"uniqueKey":"type","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","uniqueKey":"title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"title.oneOf.1","typeLabel":"null"}],"uniqueKey":"title","typeLabel":"string | null"},"status":{"oneOf":[{"type":"integer","format":"int32","uniqueKey":"status.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","uniqueKey":"status.oneOf.1","typeLabel":"null"}],"uniqueKey":"status","typeLabel":"integer\u003cint32> | null"},"detail":{"oneOf":[{"type":"string","uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail","typeLabel":"string | null"},"instance":{"oneOf":[{"type":"string","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"},"errors":{"oneOf":[{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"errors.oneOf.0.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.oneOf.0.additionalProperties","typeLabel":"string[]"},"uniqueKey":"errors.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"errors.oneOf.1.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.oneOf.1.additionalProperties","typeLabel":"string[]"},"uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"object | null"}},"additionalProperties":{"oneOf":[{}],"uniqueKey":"additionalProperties","typeLabel":"any"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>","errors":{}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"d10e24f8-f72b-42cb-89ba-7d212b24326e":{"bearer_auth":{"type":"http","description":"Specify the authorization token.\n\nFor more information, check out the [Authorization Guide](/api-reference/authorization).","scheme":"bearer","scopes":[],"schemeName":"bearer_auth"}},"fe39eb34-84be-4ead-9434-f64ad29ef824":{"oauth2_client_credentials":{"type":"oauth2","description":"OAuth2 client_credentials grant. Use the Id of an OAuth API key as `client_id` and its one-time secret as `client_secret`.","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{"pearls:read":"List and view Pearls","pearls:write":"Create and update Pearls (settings, conversation flows, voices); implies pearls:read","pearls:moderate":"Run/pause Pearls and reset customer memory; implies pearls:read","pearls:analytics":"Read Pearl analytics; implies pearls:read","pearls:leads":"Manage and read outbound leads; implies pearls:read","pearls:calls":"Read calls and recordings, make and delete calls; implies pearls:read","pearls:stream":"Create stream tokens and run calls over a WebSocket; implies pearls:read","account:phone_numbers":"Read account phone numbers and text channels, manage custom VoIP numbers, import Twilio numbers and delete phone numbers","account:users":"Read account users","account:advanced":"Manage advanced account settings (blacklist)","account:billing":"Read account information and credit balance","account:audit_log":"Read the audit log","tts":"Synthesise speech and clone voices"}}},"scopes":[],"schemeName":"oauth2_client_credentials"}}},"servers":{"97fe3b36-7240-450a-91db-08f0f513c5ca":{"url":"https://api.nlpearl.ai","description":"Production Environement"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","description":"Specify the authorization token.\n\nFor more information, check out the [Authorization Guide](/api-reference/authorization).","scheme":"bearer","scopes":[],"schemeName":"bearer_auth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Specify the authorization token.\n\nFor more information, check out the [Authorization Guide](/api-reference/authorization).","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearer_auth","name":"Authorization"}],"title":"bearer_auth"},{"schemes":[{"scheme":{"type":"oauth2","description":"OAuth2 client_credentials grant. Use the Id of an OAuth API key as `client_id` and its one-time secret as `client_secret`.","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{"pearls:read":"List and view Pearls","pearls:write":"Create and update Pearls (settings, conversation flows, voices); implies pearls:read","pearls:moderate":"Run/pause Pearls and reset customer memory; implies pearls:read","pearls:analytics":"Read Pearl analytics; implies pearls:read","pearls:leads":"Manage and read outbound leads; implies pearls:read","pearls:calls":"Read calls and recordings, make and delete calls; implies pearls:read","pearls:stream":"Create stream tokens and run calls over a WebSocket; implies pearls:read","account:phone_numbers":"Read account phone numbers and text channels, manage custom VoIP numbers, import Twilio numbers and delete phone numbers","account:users":"Read account users","account:advanced":"Manage advanced account settings (blacklist)","account:billing":"Read account information and credit balance","account:audit_log":"Read the audit log","tts":"Synthesise speech and clone voices"}}},"scopes":[],"schemeName":"oauth2_client_credentials"},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"OAuth2 client_credentials grant. Use the Id of an OAuth API key as `client_id` and its one-time secret as `client_secret`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"oauth2_client_credentials","name":"Authorization"}],"title":"oauth2_client_credentials"}]},"originalFileLocation":"api-reference/v2/openapiV2.json"},"subdomain":"nlpearl","siteName":"NLPearl Documentation","title":"Add Leads - NLPearl Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-05-26T13:51:46.020Z","originalFileLocation":"api-reference/v2/outbound/add-leads.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=\"Adds new leads to a specified outbound\">\u003cmeta data-mint-head name=\"application-name\" content=\"NLPearl Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/nlpearl/2yr4wWhG2kiDMCwL/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/nlpearl/2yr4wWhG2kiDMCwL/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/nlpearl/2yr4wWhG2kiDMCwL/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/nlpearl/2yr4wWhG2kiDMCwL/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/nlpearl/2yr4wWhG2kiDMCwL/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/nlpearl/2yr4wWhG2kiDMCwL/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/nlpearl/2yr4wWhG2kiDMCwL/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/nlpearl/2yr4wWhG2kiDMCwL/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/nlpearl/2yr4wWhG2kiDMCwL/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Add Leads - NLPearl Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Adds new leads to a specified outbound\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"NLPearl Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.nlpearl.ai/api-reference/v2/outbound/add-leads\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://nlpearl.mintlify.app/_mintlify/api/og/v2?division=Outbound\u0026amp;title=Add+Leads\u0026amp;description=Adds+new+leads+to+a+specified+outbound\u0026amp;theme=1048d0b5fa94cf7eed8d4a4d\u0026amp;signature=9b5ce5970bb9ae0fe9f7401ade19506da523c1219dc62c553cbdaec753f2c3e4\">\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=\"Add Leads - NLPearl Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Adds new leads to a specified outbound\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://nlpearl.mintlify.app/_mintlify/api/og/v2?division=Outbound\u0026amp;title=Add+Leads\u0026amp;description=Adds+new+leads+to+a+specified+outbound\u0026amp;theme=1048d0b5fa94cf7eed8d4a4d\u0026amp;signature=9b5ce5970bb9ae0fe9f7401ade19506da523c1219dc62c553cbdaec753f2c3e4\">\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=\"/mintlify-assets/_mintlify/favicons/nlpearl/2yr4wWhG2kiDMCwL/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"NLPearl Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#111111\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.nlpearl.ai/api-reference/v2/outbound/add-leads\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/v2/outbound/add-leads.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.nlpearl.ai/#organization\",\"name\":\"NLPearl Documentation\",\"url\":\"https://developers.nlpearl.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/nlpearl/DSJnNLmkdffV1qq-/images/light_mode/logo_dark.png?fit=max\u0026auto=format\u0026n=DSJnNLmkdffV1qq-\u0026q=85\u0026s=a0f34eb8d06f12c8f03693ffc4dfffeb\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.nlpearl.ai#website\",\"name\":\"NLPearl Documentation\",\"url\":\"https://developers.nlpearl.ai\",\"publisher\":{\"@id\":\"https://developers.nlpearl.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.nlpearl.ai/api-reference/v2/outbound/add-leads#webpage\",\"url\":\"https://developers.nlpearl.ai/api-reference/v2/outbound/add-leads\",\"name\":\"Add Leads\",\"description\":\"Adds new leads to a specified outbound\",\"dateModified\":\"2026-05-26T13:51:46.020Z\",\"isPartOf\":{\"@id\":\"https://developers.nlpearl.ai#website\"},\"breadcrumb\":{\"@id\":\"https://developers.nlpearl.ai/api-reference/v2/outbound/add-leads#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.nlpearl.ai/api-reference/v2/outbound/add-leads#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API V2\",\"item\":\"https://developers.nlpearl.ai/api-reference/v2/account/get-account\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Outbound\",\"item\":\"https://developers.nlpearl.ai/api-reference/v2/outbound/add-lead\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Add Leads\",\"item\":\"https://developers.nlpearl.ai/api-reference/v2/outbound/add-leads\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.nlpearl.ai/api-reference/v2/outbound/add-leads#apireference\",\"headline\":\"Add Leads\",\"name\":\"Add Leads\",\"description\":\"Adds new leads to a specified outbound\",\"url\":\"https://developers.nlpearl.ai/api-reference/v2/outbound/add-leads\",\"mainEntityOfPage\":{\"@id\":\"https://developers.nlpearl.ai/api-reference/v2/outbound/add-leads#webpage\"},\"dateModified\":\"2026-05-26T13:51:46.020Z\",\"publisher\":{\"@id\":\"https://developers.nlpearl.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.nlpearl.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"NLPearl Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"NLPearl Documentation","nav":{"global":null,"tabs":[{"tab":"Docs","pages":[{"title":"Docs","href":"/pages/introduction"}]},{"tab":"API Reference","groups":[{"group":"Getting Started","expanded":true,"pages":[{"title":"Quick Start","icon":"rocket","iconType":"light","href":"/api-reference/api_quickstart"},{"group":"API Authorization","icon":"lock","root":{"title":"API Authorization","sidebarTitle":"Overview","icon":"key","iconType":"light","href":"/api-reference/authorization"},"expanded":true,"pages":[{"title":"API Secret Key","icon":"key","iconType":"light","href":"/api-reference/api_secret_key"},{"title":"OAuth 2.0","icon":"shield-check","iconType":"light","href":"/api-reference/oauth"}]},{"title":"Pearl Flow Variables Guidance","icon":"square-root-variable","iconType":"light","href":"/api-reference/flow_variables"},{"title":"Building a Pearl Flow","icon":"diagram-project","iconType":"light","href":"/api-reference/building_a_flow"}]},{"group":"API V2","tag":"latest","expanded":true,"pages":[{"group":"Account","expanded":true,"pages":[{"openapi":"get /v2/Account","title":"Get Account","href":"/api-reference/v2/account/get-account"},{"openapi":"get /v2/Account/Users","title":"Get Users","href":"/api-reference/v2/account/get-account-users"},{"openapi":"post /v2/Account/AuditLog","title":"Get Audit Log","href":"/api-reference/v2/account/get-audit-log"},{"openapi":"get /v2/Account/Voices","title":"Get Voices","href":"/api-reference/v2/pearlSettings/get-voices"},{"openapi":"get /v2/Account/PhoneNumbers","title":"Get Phone Numbers","href":"/api-reference/v2/pearlSettings/get-phones"},{"openapi":"get /v2/Account/TextChannels","title":"Get Text Channels","href":"/api-reference/v2/pearlSettings/get-text-channels"},{"openapi":"post /v2/Account/Blacklist/Search","title":"Search Blacklist","href":"/api-reference/v2/account/search-blacklist"},{"openapi":"post /v2/Account/Blacklist","title":"Add Phone Numbers To Blacklist","href":"/api-reference/v2/account/add-to-blacklist"},{"openapi":"post /v2/Account/Blacklist/Remove","title":"Remove Phone Numbers From Blacklist","href":"/api-reference/v2/account/remove-from-blacklist"}]},{"group":"Phone Number","expanded":true,"pages":[{"openapi":"post /v2/PhoneNumber/CustomVoip","title":"Create Custom VoIP Number","href":"/api-reference/v2/phoneNumber/create-custom-voip"},{"openapi":"put /v2/PhoneNumber/CustomVoip/{phoneNumberId}","title":"Update Custom VoIP Number","href":"/api-reference/v2/phoneNumber/update-custom-voip"},{"openapi":"post /v2/PhoneNumber/Twilio/List","title":"List Twilio Phone Numbers","href":"/api-reference/v2/phoneNumber/list-twilio-phone-numbers"},{"openapi":"post /v2/PhoneNumber/Twilio/Import","title":"Import Twilio Phone Number","href":"/api-reference/v2/phoneNumber/import-twilio-phone-number"},{"openapi":"delete /v2/PhoneNumber/{phoneNumberId}","title":"Delete Phone Number","href":"/api-reference/v2/phoneNumber/delete-phone-number"}]},{"group":"Call","expanded":true,"pages":[{"openapi":"get /v2/Call/{callId}","title":"Get Call","href":"/api-reference/v2/call/get-call"},{"openapi":"get /v2/Recording/{clientId}/{pearlId}/{callId}","title":"Get Call Recording","href":"/api-reference/v2/call/get-recording"},{"openapi":"delete /v2/Call","title":"Delete Calls","href":"/api-reference/v2/call/delete-call"},{"openapi":"post /v2/Call/{callId}/Hangup","title":"Hang Up Call","href":"/api-reference/v2/call/hangup-call"}]},{"group":"Pearl","expanded":true,"pages":[{"openapi":"get /v2/Pearl","title":"Get Pearls","href":"/api-reference/v2/pearl/get-pearls"},{"openapi":"get /v2/Pearl/{pearlId}","title":"Get Pearl","href":"/api-reference/v2/pearl/get-pearl"},{"openapi":"put /v2/Pearl/{pearlId}/Active","title":"Set Activity State","href":"/api-reference/v2/pearl/set-activity-state"},{"openapi":"post /v2/Pearl/{pearlId}/Calls","title":"Get Calls","href":"/api-reference/v2/pearl/get-calls"},{"openapi":"post /v2/Pearl/{pearlId}/Calls/Bulk","title":"Get Calls Bulk","href":"/api-reference/v2/pearl/get-calls-bulk"},{"openapi":"get /v2/Pearl/{pearlId}/OngoingCalls","title":"Get Ongoing Calls","href":"/api-reference/v2/pearl/get-ongoing-calls"},{"openapi":"post /v2/Pearl/{pearlId}/Analytics","title":"Get Analytics","href":"/api-reference/v2/pearl/get-analytics"},{"openapi":"put /v2/Pearl/{pearlId}/ResetMemory","title":"Reset Customer Memory","href":"/api-reference/v2/pearl/reset-memory"}]},{"group":"Pearl Configurations","expanded":true,"pages":[{"openapi":"get /v2/Pearl/{pearlId}/Settings","title":"Get Pearl Settings","href":"/api-reference/v2/pearlFlow/get-pearl-flow"},{"openapi":"post /v2/Pearl","title":"Create Pearl","href":"/api-reference/v2/pearlFlow/add-pearl-flow"},{"openapi":"post /v2/Pearl/Voice","title":"Create Voice Pearl","href":"/api-reference/v2/pearlFlow/add-voice-pearl"},{"openapi":"post /v2/Pearl/Text","title":"Create Text Pearl","href":"/api-reference/v2/pearlFlow/add-text-pearl"},{"openapi":"put /v2/Pearl/{pearlId}","title":"Update Pearl","href":"/api-reference/v2/pearlFlow/update-pearl-flow"},{"openapi":"put /v2/Pearl/Voice/{pearlId}","title":"Update Voice Pearl","href":"/api-reference/v2/pearlFlow/update-voice-pearl"},{"openapi":"put /v2/Pearl/Text/{pearlId}","title":"Update Text Pearl","href":"/api-reference/v2/pearlFlow/update-text-pearl"},{"openapi":"put /v2/Pearl/{pearlId}/Settings/Inbound","title":"Update Inbound Settings","href":"/api-reference/v2/pearlFlow/update-pearl-inbound"},{"openapi":"put /v2/Pearl/{pearlId}/Settings/Outbound","title":"Update Outbound Settings","href":"/api-reference/v2/pearlFlow/update-pearl-outbound"},{"openapi":"get /v2/Pearl/Credential/{pearlId}","title":"Get Pearl Credentials","href":"/api-reference/v2/pearlFlow/get-pearl-credentials"}]},{"group":"Outbound","expanded":true,"pages":[{"openapi":"post /v2/Outbound/{pearlId}/Lead","title":"Add Lead","description":"Adds a new lead to a specified outbound","href":"/api-reference/v2/outbound/add-lead"},{"openapi":"post /v2/Outbound/{pearlId}/Leads/Add","title":"Add Leads","href":"/api-reference/v2/outbound/add-leads"},{"openapi":"put /v2/Outbound/{pearlId}/Lead/{leadId}","title":"Update Lead","description":"Updates the details of an existing lead associated with a specific outbound campaign.","href":"/api-reference/v2/outbound/update-lead"},{"openapi":"get /v2/Outbound/{pearlId}/Lead/{leadId}","title":"Get Lead","href":"/api-reference/v2/outbound/get-lead"},{"openapi":"get /v2/Outbound/{pearlId}/Lead/External/{externalId}","title":"Get Lead Via External ID","href":"/api-reference/v2/outbound/get-lead-via-external-id"},{"openapi":"get /v2/Outbound/{pearlId}/Lead/PhoneNumber/{phoneNumber}","title":"Find Lead Via Phone Number","href":"/api-reference/v2/outbound/get-lead-via-phone-number"},{"openapi":"post /v2/Outbound/{pearlId}/Leads","title":"Search Leads","href":"/api-reference/v2/outbound/search-leads"},{"openapi":"delete /v2/Outbound/{pearlId}/Leads","title":"Delete Leads","href":"/api-reference/v2/outbound/delete-leads"},{"openapi":"delete /v2/Outbound/{pearlId}/Leads/External","title":"Delete leads Via External","href":"/api-reference/v2/outbound/delete-leads-external-id"}]},{"group":"Speech","expanded":true,"pages":[{"openapi":"post /v2/Speech","title":"Text to Speech","href":"/api-reference/v2/speech/text-to-speech"},{"openapi":"post /v2/Speech/Stream","title":"Text to Speech (Streaming)","href":"/api-reference/v2/speech/text-to-speech-stream"},{"openapi":"post /v2/Speech/Clone","title":"Clone a Voice","href":"/api-reference/v2/speech/clone-voice"}]},{"group":"Stream Calls","expanded":true,"pages":[{"openapi":"post /v2/Pearl/{pearlId}/Stream/Token","title":"Create Stream Token","href":"/api-reference/v2/stream/create-token"},{"openapi":"get /Stream/WebSocket","playground":"none","title":"Stream WebSocket","href":"/api-reference/v2/stream/websocket"}]}]},{"group":"API V1","tag":"legacy","pages":[{"group":"Account","pages":[{"openapi":"get /v1/Account","title":"Get Account","href":"/api-reference/v1/account/get-account"}]},{"group":"Call","pages":[{"openapi":"get /v1/Call/{callId}","title":"Get Call","href":"/api-reference/v1/call/get-call"},{"openapi":"delete /v1/Call","title":"Delete Calls","href":"/api-reference/v1/call/delete-call"}]},{"group":"Pearl","pages":[{"openapi":"put /v1/Pearl/{pearlId}/Memory/{phoneNumber}/Reset","title":"Reset Customer Memory","href":"/api-reference/v1/pearl/reset-memory"}]},{"group":"Inbound","pages":[{"openapi":"get /v1/Inbound","title":"Get Inbounds","href":"/api-reference/v1/inbound/get-inbounds"},{"openapi":"get /v1/Inbound/{inboundId}","title":"Get Inbound","href":"/api-reference/v1/inbound/get-inbound"},{"openapi":"get /v1/Inbound/{inboundId}/OngoingCalls","title":"Get Inbound Ongoing Calls","href":"/api-reference/v1/inbound/get-inbound-ongoing-calls"},{"openapi":"post /v1/Inbound/{inboundId}/Active","title":"Set Activity State","href":"/api-reference/v1/inbound/set-activity-state"},{"openapi":"post /v1/Inbound/{inboundId}/Calls","title":"Search Calls","href":"/api-reference/v1/inbound/search-calls"},{"openapi":"post /v1/Inbound/{inboundId}/Analytics","title":"Get Analytics","href":"/api-reference/v1/inbound/get-analytics"}]},{"group":"Outbound","pages":[{"openapi":"get /v1/Outbound","title":"Get Outbounds","href":"/api-reference/v1/outbound/get-outbounds"},{"openapi":"get /v1/Outbound/{outboundId}","title":"Get Outbound","href":"/api-reference/v1/outbound/get-outbound"},{"openapi":"get /v1/Outbound/{outboundId}/Lead/{leadId}","title":"Get Lead","href":"/api-reference/v1/outbound/get-lead"},{"openapi":"get /v1/Outbound/{outboundId}/Lead/External/{externalId}","title":"Get Lead via External ID","href":"/api-reference/v1/outbound/get-lead-via-external-id"},{"openapi":"get /v1/Outbound/{outboundId}/Lead/PhoneNumber/{phoneNumber}","title":"Get Lead via Phone Number","href":"/api-reference/v1/outbound/get-lead-via-phone-number"},{"openapi":"get /v1/Outbound/CallRequest/{requestId}","title":"Get Call Request","href":"/api-reference/v1/outbound/get-call-request"},{"openapi":"post /v1/Outbound/{outboundId}/Analytics","title":"Get Analytics","href":"/api-reference/v1/outbound/get-analytics"},{"openapi":"post /v1/Outbound/{outboundId}/Active","title":"Set Activity State","href":"/api-reference/v1/outbound/set-activity-state"},{"openapi":"post /v1/Outbound/{outboundId}/Calls","title":"Search Calls","href":"/api-reference/v1/outbound/search-calls"},{"openapi":"post /v1/Outbound/{outboundId}/Leads","title":"Search Leads","href":"/api-reference/v1/outbound/search-leads"},{"openapi":"post /v1/Outbound/{outboundId}/Call","title":"Make Call","href":"/api-reference/v1/outbound/make-call"},{"openapi":"post /v1/Outbound/{outboundId}/CallRequest","title":"Search Call Requests","href":"/api-reference/v1/outbound/search-call-requests"},{"openapi":"put /v1/Outbound/{outboundId}/Lead","title":"Add Lead","href":"/api-reference/v1/outbound/add-lead"},{"openapi":"put /v1/Outbound/{outboundId}/Lead/{leadId}","title":"Update Lead","href":"/api-reference/v1/outbound/update-lead"},{"openapi":"delete /v1/Outbound/{outboundId}/Leads","title":"Delete Leads","href":"/api-reference/v1/outbound/delete-leads"},{"openapi":"delete /v1/Outbound/{outboundId}/Leads/External","title":"Delete leads Via External","href":"/api-reference/v1/outbound/delete-leads-external-id"}]}]}]}]},"basePath":"","title":"Add Leads - NLPearl Documentation","buildId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","deploymentId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","dynamics":["10e4515597","c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["BannerMarkdown-DIeMibn4.js","dist-DJnKvr0g.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","clsx-B2v50t8t.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-C8RPHPxo.js","utils-0BK-9q6z.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DfjzsUJT.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B4v9psJ4.js","snippetPresets-CpTQv-Ez.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-Buji1S4J.js","ApiExamples-BNP-Fvr0.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BSgu6h1D.js","shallow-Biv1i9Gs.js","getApiPlaygroundDisplay-BoGOXhtF.js","CodeSnippet-DvQoT18_.js","CodeSnippets-Dnpa15xT.js","getPastedJson-xAIyhUFE.js","icon-S6FBih11.js","MethodPill-SaYeUZyk.js","DuplicateIcon-Cs-p3v2Q.js","createIcon-DjCFEoHq.js","DynamicMarkdown-BcnBltEQ.js","SectionHeading-BUBl0eEF.js","axios-vUo_bRtp.js","Markdown-h4cOoD8d.js","AssistantPageLink-BHrrjR1K.js"]}