To update attributes for a lead, include an attributes object in the request body. Each key in the attributes object represents an attribute ID, and its corresponding value is the new value for that attribute.
provider a wrong value for an attribute will result in an error response.Example:
{ "attributes": { "attribute-id-1": "New Value 1", "attribute-id-2": 42, "attribute-id-3": true, "select-attribute-id": "option-id-1", "multiselect-attribute-id": ["option-id-2", "option-id-3"] }}
{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Breakcold","colors":{"primary":"#0059F7","light":"#0059F7","dark":"#0059F7"},"logo":{"light":"https://mintcdn.com/breakcold/BWIqt0FmONF4bgJW/logo/light.svg?fit=max\u0026auto=format\u0026n=BWIqt0FmONF4bgJW\u0026q=85\u0026s=5657e1df05ce4b5a1bf2a0db22b75366","dark":"https://mintcdn.com/breakcold/BWIqt0FmONF4bgJW/logo/dark.svg?fit=max\u0026auto=format\u0026n=BWIqt0FmONF4bgJW\u0026q=85\u0026s=2c7c65540a4502572e09dc3c24461285"},"favicon":"https://mintcdn.com/breakcold/BWIqt0FmONF4bgJW/favicon.svg?fit=max\u0026auto=format\u0026n=BWIqt0FmONF4bgJW\u0026q=85\u0026s=b3f9c2f6f1468b2afae20667d4fb014b","navbar":{"links":[{"href":"mailto:support@breakcold.com","label":"Support"},{"href":"/help","label":"Support Help Center"}],"primary":{"type":"button","label":"Login","href":"https://app.breakcold.com/signin"}},"footer":{"socials":{"x":"https://x.com/breakcold_","linkedin":"https://www.linkedin.com/company/breakcold"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"breakcold","hasAudioNarration":false,"actualSubdomain":"breakcold","customDomains":["developer.breakcold.com"],"gitSource":{"type":"github","owner":"breakcold","repo":"monorepo","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a439bc1b2dbe6fd811f759a","collectionId":"ead8b91f-4447-46cb-b721-7d08a1712ff3","schemaVersion":"v3"},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6ae91fc9142dc7511ce5d57d:success","clientVersion":"0.0.4054","searchFilterCounts":[{"language":"default","tag":"Support Help Center","count":343},{"language":"default","tag":"Help Center","count":343},{"language":"default","tag":"Contacts \u0026 Lists","count":79},{"language":"default","tag":"Developer Docs","count":48},{"language":"default","tag":"Inbox \u0026 Messaging","count":46},{"language":"default","tag":"API Reference","count":43},{"language":"default","tag":"Pipeline \u0026 Deals","count":36},{"language":"default","tag":"Integrations \u0026 API","count":30},{"language":"default","tag":"LinkedIn \u0026 Extension","count":29},{"language":"default","tag":"Account \u0026 Billing","count":25}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"v3/api-reference/leads/create-a-lead","slug":"/v3/api-reference/leads/create-a-lead","pageMetadata":{"title":"Create Lead","openapi":"POST /lead","description":null,"href":"/v3/api-reference/leads/create-a-lead"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{CodeBlock,Heading}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`3`,id:`updating-lead-custom-attributes`,children:`Updating Lead Custom Attributes`}),`\n`,_jsxs(_components.p,{children:[`To update attributes for a lead, include an `,_jsx(_components.code,{children:`attributes`}),` object in the request body. Each key in the `,_jsx(_components.code,{children:`attributes`}),` object represents an attribute ID, and its corresponding value is the new value for that attribute.\nprovider a wrong value for an attribute will result in an error response.`]}),`\n`,_jsx(_components.p,{children:`Example:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`9`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`9`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"attributes\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"attribute-id-1\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"New Value 1\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"attribute-id-2\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`42`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"attribute-id-3\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"select-attribute-id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"option-id-1\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"multiselect-attribute-id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"option-id-2\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"option-id-3\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`]`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create Lead","openapi":"POST /lead","description":null,"href":"/v3/api-reference/leads/create-a-lead"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Updating Lead Custom Attributes","slug":"updating-lead-custom-attributes","depth":3,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"lead-create","summary":"Create a lead","tags":["Leads"],"security":["a2f455cf-7180-4171-9f7c-5d120e63949a"],"requestBody":"6c9b734a-b47d-44fc-992a-81eb782b65c4","responses":{"200":"906fdf01-eddc-4c6c-90fa-7626c163b80c","400":"e764c16b-308a-48aa-b52c-d507a0800d13","401":"d412e3cc-e1cb-402c-8d72-7f1534fb7ba6","403":"55a690ac-3f73-46f9-9aee-e8c32f63512d","500":"71ba7669-22e1-4833-b0b7-4d7f1e89c5f3"},"method":"post","type":"path","servers":["f1f5e226-ff46-4bc5-9403-0ed5b2fd24f5"],"path":"/lead","baseUrlOptions":["https://api.breakcold.com/rest"],"title":"Create a lead","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"id","typeLabel":"string"},"company":{"oneOf":[{"type":"string","uniqueKey":"company.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"company.oneOf.1","typeLabel":"null"}],"uniqueKey":"company","typeLabel":"string | null"},"company_role":{"oneOf":[{"type":"string","uniqueKey":"company_role.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"company_role.oneOf.1","typeLabel":"null"}],"uniqueKey":"company_role","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","uniqueKey":"phone.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"phone.oneOf.1","typeLabel":"number"},{"type":"null","uniqueKey":"phone.oneOf.2","typeLabel":"null"}],"uniqueKey":"phone","typeLabel":"string | number | null"},"first_name":{"oneOf":[{"type":"string","uniqueKey":"first_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"first_name","typeLabel":"string | null"},"linkedin_url":{"oneOf":[{"type":"string","uniqueKey":"linkedin_url.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"linkedin_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"linkedin_url","typeLabel":"string | null"},"linkedin_company_url":{"oneOf":[{"type":"string","uniqueKey":"linkedin_company_url.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"linkedin_company_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"linkedin_company_url","typeLabel":"string | null"},"facebook_username":{"type":"string","uniqueKey":"facebook_username","typeLabel":"string"},"telegram_username":{"type":"string","uniqueKey":"telegram_username","typeLabel":"string"},"whatsapp_username":{"type":"string","uniqueKey":"whatsapp_username","typeLabel":"string"},"youtube_username":{"type":"string","uniqueKey":"youtube_username","typeLabel":"string"},"instagram_username":{"type":"string","uniqueKey":"instagram_username","typeLabel":"string"},"twitter_name":{"oneOf":[{"type":"string","uniqueKey":"twitter_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"twitter_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"twitter_name","typeLabel":"string | null"},"twitter_company_name":{"oneOf":[{"type":"string","uniqueKey":"twitter_company_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"twitter_company_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"twitter_company_name","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","uniqueKey":"city.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"city.oneOf.1","typeLabel":"null"}],"uniqueKey":"city","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","uniqueKey":"last_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"last_name","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","uniqueKey":"email.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"email.oneOf.1","typeLabel":"null"}],"uniqueKey":"email","typeLabel":"string | null"},"is_company":{"type":"boolean","default":false,"uniqueKey":"is_company","typeLabel":"boolean"},"is_contract":{"type":"boolean","default":false,"uniqueKey":"is_contract","typeLabel":"boolean"},"create_company_if_not_exists":{"type":"boolean","default":true,"uniqueKey":"create_company_if_not_exists","typeLabel":"boolean"},"avatar_url":{"oneOf":[{"type":"string","uniqueKey":"avatar_url.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"avatar_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"avatar_url","typeLabel":"string | null"},"website_url":{"oneOf":[{"type":"string","uniqueKey":"website_url.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"website_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"website_url","typeLabel":"string | null"},"lists":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"lists.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"lists.oneOf.0","typeLabel":"string[]"},{"type":"string","uniqueKey":"lists.oneOf.1","typeLabel":"string"}],"uniqueKey":"lists","typeLabel":"string[] | string"},"status":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"status.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"status.oneOf.0","typeLabel":"string[]"},{"type":"string","uniqueKey":"status.oneOf.1","typeLabel":"string"}],"uniqueKey":"status","typeLabel":"string[] | string"},"tags":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"tags.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"tags.oneOf.0","typeLabel":"string[]"},{"type":"string","uniqueKey":"tags.oneOf.1","typeLabel":"string"}],"uniqueKey":"tags","typeLabel":"string[] | string"},"owners":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"owners.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"owners.oneOf.0","typeLabel":"string[]"},{"type":"string","uniqueKey":"owners.oneOf.1","typeLabel":"string"}],"uniqueKey":"owners","typeLabel":"string[] | string"},"contract_currency":{"type":"string","enum":["USD","EUR","JPY","GBP","AUD","CAD","CHF","CNY","HKD","NZD","INR","PLN"],"uniqueKey":"contract_currency","typeLabel":"enum\u003cstring>"},"contract_name":{"oneOf":[{"type":"string","uniqueKey":"contract_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"contract_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"contract_name","typeLabel":"string | null"},"contract_value":{"oneOf":[{"type":"string","uniqueKey":"contract_value.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"contract_value.oneOf.1","typeLabel":"number"},{"type":"null","uniqueKey":"contract_value.oneOf.2","typeLabel":"null"}],"uniqueKey":"contract_value","typeLabel":"string | number | null"},"id_list":{"type":"string","uniqueKey":"id_list","typeLabel":"string"},"attributes":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"attributes.additionalProperties","typeLabel":"any"},"uniqueKey":"attributes","typeLabel":"object"},"icebreaker":{"oneOf":[{"type":"string","uniqueKey":"icebreaker.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"icebreaker.oneOf.1","typeLabel":"null"}],"uniqueKey":"icebreaker","typeLabel":"string | null"},"icebreaker_2":{"oneOf":[{"type":"string","uniqueKey":"icebreaker_2.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"icebreaker_2.oneOf.1","typeLabel":"null"}],"uniqueKey":"icebreaker_2","typeLabel":"string | null"},"icebreaker_3":{"oneOf":[{"type":"string","uniqueKey":"icebreaker_3.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"icebreaker_3.oneOf.1","typeLabel":"null"}],"uniqueKey":"icebreaker_3","typeLabel":"string | null"},"icebreaker_4":{"oneOf":[{"type":"string","uniqueKey":"icebreaker_4.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"icebreaker_4.oneOf.1","typeLabel":"null"}],"uniqueKey":"icebreaker_4","typeLabel":"string | null"},"is_draft":{"type":"boolean","default":false,"uniqueKey":"is_draft","typeLabel":"boolean"},"auto_assign_owner":{"type":"boolean","default":true,"description":"Auto assign the owner to the current user","uniqueKey":"auto_assign_owner","typeLabel":"boolean"},"company_avatar_url":{"oneOf":[{"type":"string","uniqueKey":"company_avatar_url.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"company_avatar_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"company_avatar_url","typeLabel":"string | null"},"company_linkedin_url":{"oneOf":[{"type":"string","uniqueKey":"company_linkedin_url.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"company_linkedin_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"company_linkedin_url","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","company":"\u003cstring>","company_role":"\u003cstring>","phone":"\u003cstring>","first_name":"\u003cstring>","linkedin_url":"\u003cstring>","linkedin_company_url":"\u003cstring>","facebook_username":"\u003cstring>","telegram_username":"\u003cstring>","whatsapp_username":"\u003cstring>","youtube_username":"\u003cstring>","instagram_username":"\u003cstring>","twitter_name":"\u003cstring>","twitter_company_name":"\u003cstring>","city":"\u003cstring>","last_name":"\u003cstring>","email":"\u003cstring>","is_company":false,"is_contract":false,"create_company_if_not_exists":true,"avatar_url":"\u003cstring>","website_url":"\u003cstring>","lists":["\u003cstring>"],"status":["\u003cstring>"],"tags":["\u003cstring>"],"owners":["\u003cstring>"],"contract_name":"\u003cstring>","contract_value":"\u003cstring>","id_list":"\u003cstring>","attributes":{},"icebreaker":"\u003cstring>","icebreaker_2":"\u003cstring>","icebreaker_3":"\u003cstring>","icebreaker_4":"\u003cstring>","is_draft":false,"auto_assign_owner":true,"company_avatar_url":"\u003cstring>","company_linkedin_url":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"906fdf01-eddc-4c6c-90fa-7626c163b80c":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"email":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"email.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"email.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"email","typeLabel":"string | null"},"company":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"company.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"company.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"company","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"phone.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"phone.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"phone","typeLabel":"string | null"},"linkedin_url":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"linkedin_url.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"linkedin_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"linkedin_url","typeLabel":"string | null"},"linkedin_company_url":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"linkedin_company_url.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"linkedin_company_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"linkedin_company_url","typeLabel":"string | null"},"facebook_username":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"facebook_username.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"facebook_username.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"facebook_username","typeLabel":"string | null"},"youtube_username":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"youtube_username.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"youtube_username.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"youtube_username","typeLabel":"string | null"},"instagram_username":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"instagram_username.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"instagram_username.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"instagram_username","typeLabel":"string | null"},"telegram_username":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"telegram_username.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"telegram_username.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"telegram_username","typeLabel":"string | null"},"whatsapp_username":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"whatsapp_username.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"whatsapp_username.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"whatsapp_username","typeLabel":"string | null"},"search_query":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"search_query.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"search_query.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"search_query","typeLabel":"string | null"},"created_at":{"type":"string","isRequired":true,"uniqueKey":"created_at","typeLabel":"string"},"updated_at":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"updated_at.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"updated_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"updated_at","typeLabel":"string | null"},"first_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"first_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"first_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"first_name","typeLabel":"string | null"},"icebreaker":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"icebreaker.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"icebreaker.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"icebreaker","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"last_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"last_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"last_name","typeLabel":"string | null"},"website_url":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"website_url.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"website_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"website_url","typeLabel":"string | null"},"timezone":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"timezone.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"timezone.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"timezone","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"city.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"city.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"city","typeLabel":"string | null"},"company_role":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"company_role.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"company_role.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"company_role","typeLabel":"string | null"},"twitter_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"twitter_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"twitter_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"twitter_name","typeLabel":"string | null"},"avatar_url":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"avatar_url.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"avatar_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"avatar_url","typeLabel":"string | null"},"icebreaker_2":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"icebreaker_2.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"icebreaker_2.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"icebreaker_2","typeLabel":"string | null"},"icebreaker_3":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"icebreaker_3.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"icebreaker_3.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"icebreaker_3","typeLabel":"string | null"},"icebreaker_4":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"icebreaker_4.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"icebreaker_4.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"icebreaker_4","typeLabel":"string | null"},"email_bounce_score":{"oneOf":[{"type":"integer","isRequired":true,"uniqueKey":"email_bounce_score.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"email_bounce_score.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"email_bounce_score","typeLabel":"integer | null"},"twitter_company_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"twitter_company_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"twitter_company_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"twitter_company_name","typeLabel":"string | null"},"is_company":{"type":"boolean","isRequired":true,"uniqueKey":"is_company","typeLabel":"boolean"},"is_contract":{"type":"boolean","isRequired":true,"uniqueKey":"is_contract","typeLabel":"boolean"},"is_tracked":{"oneOf":[{"type":"boolean","isRequired":true,"uniqueKey":"is_tracked.oneOf.0","typeLabel":"boolean"},{"type":"null","isRequired":true,"uniqueKey":"is_tracked.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"is_tracked","typeLabel":"boolean | null"},"is_deleted":{"type":"boolean","isRequired":true,"uniqueKey":"is_deleted","typeLabel":"boolean"},"is_deleted_at":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"is_deleted_at.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"is_deleted_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"is_deleted_at","typeLabel":"string | null"},"order":{"type":"integer","isRequired":true,"uniqueKey":"order","typeLabel":"integer"},"contract_value":{"oneOf":[{"type":"integer","isRequired":true,"uniqueKey":"contract_value.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"contract_value.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"contract_value","typeLabel":"integer | null"},"contract_currency":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"contract_currency.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"contract_currency.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"contract_currency","typeLabel":"string | null"},"contract_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"contract_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"contract_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"contract_name","typeLabel":"string | null"},"score":{"oneOf":[{"type":"integer","isRequired":true,"uniqueKey":"score.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"score.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"score","typeLabel":"integer | null"},"ai_enabled":{"type":"boolean","isRequired":true,"uniqueKey":"ai_enabled","typeLabel":"boolean"},"ai_enabled_at":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"ai_enabled_at.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"ai_enabled_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"ai_enabled_at","typeLabel":"string | null"},"ai_summary":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"ai_summary.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"ai_summary.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"ai_summary","typeLabel":"string | null"},"ai_profile":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"ai_profile.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"ai_profile.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"ai_profile","typeLabel":"string | null"},"is_draft":{"type":"boolean","isRequired":true,"uniqueKey":"is_draft","typeLabel":"boolean"},"last_interaction_at":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"last_interaction_at.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"last_interaction_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"last_interaction_at","typeLabel":"string | null"},"id_linkedin_company":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"id_linkedin_company.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"id_linkedin_company.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"id_linkedin_company","typeLabel":"string | null"},"id_linkedin":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"id_linkedin.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"id_linkedin.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"id_linkedin","typeLabel":"string | null"},"id_space":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"id_space.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"id_space.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"id_space","typeLabel":"string | null"},"usersId":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"usersId.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"usersId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"usersId","typeLabel":"string | null"}},"required":["id","email","company","phone","linkedin_url","linkedin_company_url","facebook_username","youtube_username","instagram_username","telegram_username","whatsapp_username","search_query","created_at","updated_at","first_name","icebreaker","last_name","website_url","timezone","city","company_role","twitter_name","avatar_url","icebreaker_2","icebreaker_3","icebreaker_4","email_bounce_score","twitter_company_name","is_company","is_contract","is_tracked","is_deleted","is_deleted_at","order","contract_value","contract_currency","contract_name","score","ai_enabled","ai_enabled_at","ai_summary","ai_profile","is_draft","last_interaction_at","id_linkedin_company","id_linkedin","id_space","usersId"],"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","email":"\u003cstring>","company":"\u003cstring>","phone":"\u003cstring>","linkedin_url":"\u003cstring>","linkedin_company_url":"\u003cstring>","facebook_username":"\u003cstring>","youtube_username":"\u003cstring>","instagram_username":"\u003cstring>","telegram_username":"\u003cstring>","whatsapp_username":"\u003cstring>","search_query":"\u003cstring>","created_at":"\u003cstring>","updated_at":"\u003cstring>","first_name":"\u003cstring>","icebreaker":"\u003cstring>","last_name":"\u003cstring>","website_url":"\u003cstring>","timezone":"\u003cstring>","city":"\u003cstring>","company_role":"\u003cstring>","twitter_name":"\u003cstring>","avatar_url":"\u003cstring>","icebreaker_2":"\u003cstring>","icebreaker_3":"\u003cstring>","icebreaker_4":"\u003cstring>","email_bounce_score":123,"twitter_company_name":"\u003cstring>","is_company":true,"is_contract":true,"is_tracked":true,"is_deleted":true,"is_deleted_at":"\u003cstring>","order":123,"contract_value":123,"contract_currency":"\u003cstring>","contract_name":"\u003cstring>","score":123,"ai_enabled":true,"ai_enabled_at":"\u003cstring>","ai_summary":"\u003cstring>","ai_profile":"\u003cstring>","is_draft":true,"last_interaction_at":"\u003cstring>","id_linkedin_company":"\u003cstring>","id_linkedin":"\u003cstring>","id_space":"\u003cstring>","usersId":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"e764c16b-308a-48aa-b52c-d507a0800d13":{"description":"Invalid input data","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"The error message","example":"Invalid input data","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"The error code","example":"BAD_REQUEST","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"issues":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"issues.items.[INDEX].message","typeLabel":"string"}},"required":["message"],"uniqueKey":"issues.items.[INDEX]","typeLabel":"object"},"description":"An array of issues that were responsible for the error","example":[],"uniqueKey":"issues","typeLabel":"object[]"}},"required":["message","code"],"title":"Invalid input data error (400)","description":"The error information","example":{"code":"BAD_REQUEST","message":"Invalid input data","issues":[]},"uniqueKey":"","typeLabel":"Invalid input data error (400) · object"},"examples":{"Example":{"title":"Example","value":{"code":"BAD_REQUEST","message":"Invalid input data","issues":[]}}},"exampleType":"generated"}},"exampleType":"generated"},"d412e3cc-e1cb-402c-8d72-7f1534fb7ba6":{"description":"Authorization not provided","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"The error message","example":"Authorization not provided","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"The error code","example":"UNAUTHORIZED","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"issues":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"issues.items.[INDEX].message","typeLabel":"string"}},"required":["message"],"uniqueKey":"issues.items.[INDEX]","typeLabel":"object"},"description":"An array of issues that were responsible for the error","example":[],"uniqueKey":"issues","typeLabel":"object[]"}},"required":["message","code"],"title":"Authorization not provided error (401)","description":"The error information","example":{"code":"UNAUTHORIZED","message":"Authorization not provided","issues":[]},"uniqueKey":"","typeLabel":"Authorization not provided error (401) · object"},"examples":{"Example":{"title":"Example","value":{"code":"UNAUTHORIZED","message":"Authorization not provided","issues":[]}}},"exampleType":"generated"}},"exampleType":"generated"},"55a690ac-3f73-46f9-9aee-e8c32f63512d":{"description":"Insufficient access","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"The error message","example":"Insufficient access","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"The error code","example":"FORBIDDEN","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"issues":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"issues.items.[INDEX].message","typeLabel":"string"}},"required":["message"],"uniqueKey":"issues.items.[INDEX]","typeLabel":"object"},"description":"An array of issues that were responsible for the error","example":[],"uniqueKey":"issues","typeLabel":"object[]"}},"required":["message","code"],"title":"Insufficient access error (403)","description":"The error information","example":{"code":"FORBIDDEN","message":"Insufficient access","issues":[]},"uniqueKey":"","typeLabel":"Insufficient access error (403) · object"},"examples":{"Example":{"title":"Example","value":{"code":"FORBIDDEN","message":"Insufficient access","issues":[]}}},"exampleType":"generated"}},"exampleType":"generated"},"71ba7669-22e1-4833-b0b7-4d7f1e89c5f3":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"The error message","example":"Internal server error","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"The error code","example":"INTERNAL_SERVER_ERROR","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"issues":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"issues.items.[INDEX].message","typeLabel":"string"}},"required":["message"],"uniqueKey":"issues.items.[INDEX]","typeLabel":"object"},"description":"An array of issues that were responsible for the error","example":[],"uniqueKey":"issues","typeLabel":"object[]"}},"required":["message","code"],"title":"Internal server error error (500)","description":"The error information","example":{"code":"INTERNAL_SERVER_ERROR","message":"Internal server error","issues":[]},"uniqueKey":"","typeLabel":"Internal server error error (500) · object"},"examples":{"Example":{"title":"Example","value":{"code":"INTERNAL_SERVER_ERROR","message":"Internal server error","issues":[]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"a2f455cf-7180-4171-9f7c-5d120e63949a":{"Authorization":{"type":"apiKey","in":"header","name":"X-API-KEY","scopes":[]}}},"servers":{"f1f5e226-ff46-4bc5-9403-0ed5b2fd24f5":{"url":"https://api.breakcold.com/rest"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-KEY","scopes":[]},"schema":{"title":"X-API-KEY","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"Authorization","name":"X-API-KEY"}],"title":"Authorization"}]},"originalFileLocation":"v3/api-reference/openapi.json"},"subdomain":"breakcold","siteName":"Breakcold","title":"Create Lead - Breakcold","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-06-30T10:35:01.498Z","originalFileLocation":"v3/api-reference/leads/create-a-lead.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=\"application-name\" content=\"Breakcold\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/breakcold/R4oxvLB_h1Kw6Pwr/_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/breakcold/R4oxvLB_h1Kw6Pwr/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/breakcold/R4oxvLB_h1Kw6Pwr/_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/breakcold/R4oxvLB_h1Kw6Pwr/_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/breakcold/R4oxvLB_h1Kw6Pwr/_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/breakcold/R4oxvLB_h1Kw6Pwr/_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/breakcold/R4oxvLB_h1Kw6Pwr/_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/breakcold/R4oxvLB_h1Kw6Pwr/_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/breakcold/R4oxvLB_h1Kw6Pwr/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create Lead - Breakcold\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Breakcold\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.breakcold.com/v3/api-reference/leads/create-a-lead\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://breakcold.mintlify.app/_mintlify/api/og/v2?division=Leads\u0026amp;title=Create+Lead\u0026amp;theme=7d2359f0bfd66ad7b5184c27\u0026amp;signature=849eb7d14166eae1b188a3c0e486b912907b84b277dd0d266d0e7f509efd21f4\">\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=\"Create Lead - Breakcold\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://breakcold.mintlify.app/_mintlify/api/og/v2?division=Leads\u0026amp;title=Create+Lead\u0026amp;theme=7d2359f0bfd66ad7b5184c27\u0026amp;signature=849eb7d14166eae1b188a3c0e486b912907b84b277dd0d266d0e7f509efd21f4\">\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/breakcold/R4oxvLB_h1Kw6Pwr/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Breakcold\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0059F7\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.breakcold.com/v3/api-reference/leads/create-a-lead\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/v3/api-reference/leads/create-a-lead.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.breakcold.com/#organization\",\"name\":\"Breakcold\",\"url\":\"https://developer.breakcold.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/breakcold/BWIqt0FmONF4bgJW/logo/light.svg?fit=max\u0026auto=format\u0026n=BWIqt0FmONF4bgJW\u0026q=85\u0026s=5657e1df05ce4b5a1bf2a0db22b75366\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.breakcold.com#website\",\"name\":\"Breakcold\",\"url\":\"https://developer.breakcold.com\",\"publisher\":{\"@id\":\"https://developer.breakcold.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.breakcold.com/v3/api-reference/leads/create-a-lead#webpage\",\"url\":\"https://developer.breakcold.com/v3/api-reference/leads/create-a-lead\",\"name\":\"Create Lead\",\"dateModified\":\"2026-06-30T10:35:01.498Z\",\"isPartOf\":{\"@id\":\"https://developer.breakcold.com#website\"},\"breadcrumb\":{\"@id\":\"https://developer.breakcold.com/v3/api-reference/leads/create-a-lead#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.breakcold.com/v3/api-reference/leads/create-a-lead#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Breakcold\",\"item\":\"https://developer.breakcold.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create Lead\",\"item\":\"https://developer.breakcold.com/v3/api-reference/leads/create-a-lead\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.breakcold.com/v3/api-reference/leads/create-a-lead#apireference\",\"headline\":\"Create Lead\",\"name\":\"Create Lead\",\"url\":\"https://developer.breakcold.com/v3/api-reference/leads/create-a-lead\",\"mainEntityOfPage\":{\"@id\":\"https://developer.breakcold.com/v3/api-reference/leads/create-a-lead#webpage\"},\"dateModified\":\"2026-06-30T10:35:01.498Z\",\"publisher\":{\"@id\":\"https://developer.breakcold.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.breakcold.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Breakcold\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Breakcold","nav":{"global":null,"tabs":[{"tab":"Support Help Center","pages":[{"title":"Support Help Center","href":"/help"}]},{"tab":"Developer Docs","anchors":[{"anchor":"Developer Guides","icon":"book-open","pages":[{"title":"Developer Guides","href":"/v3/quickstart"}]},{"anchor":"API Reference","icon":"square-terminal","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/v3/api-reference/introduction"}]},{"group":"User","pages":[{"title":"Get user details","deprecated":null,"version":null,"openapi":"/v3/api-reference/openapi.json get /me","href":"/v3/api-reference/user/get-user-details"}]},{"group":"Status","pages":[{"title":"Create a status","deprecated":null,"version":null,"openapi":"/v3/api-reference/openapi.json post /status","href":"/v3/api-reference/status/create-a-status"},{"title":"Update many status","deprecated":null,"version":null,"openapi":"/v3/api-reference/openapi.json patch /status","href":"/v3/api-reference/status/update-many-status"},{"title":"Delete a status","deprecated":null,"version":null,"openapi":"/v3/api-reference/openapi.json delete /status/{id}","href":"/v3/api-reference/status/delete-a-status"},{"title":"Update a status","deprecated":null,"version":null,"openapi":"/v3/api-reference/openapi.json patch /status/{id}","href":"/v3/api-reference/status/update-a-status"}]},{"group":"Workspaces","pages":[{"title":"Get user workspaces","deprecated":null,"version":null,"openapi":"/v3/api-reference/openapi.json get /workspaces","href":"/v3/api-reference/workspaces/get-user-workspaces"}]},{"group":"Members","pages":[{"title":"Get members of a workspace","description":null,"deprecated":null,"version":null,"openapi":"/v3/api-reference/openapi.json get /members","href":"/v3/api-reference/members/get-members-of-a-workspace"}]},{"group":"Leads","pages":[{"title":"Create Lead","openapi":"POST /lead","href":"/v3/api-reference/leads/create-a-lead"},{"title":"Get a lead by id","description":null,"deprecated":null,"version":null,"openapi":"/v3/api-reference/openapi.json get /leads/{id}","href":"/v3/api-reference/leads/get-a-lead-by-id"},{"title":"Delete a lead","deprecated":null,"version":null,"openapi":"/v3/api-reference/openapi.json delete /leads/{id}","href":"/v3/api-reference/leads/delete-a-lead"},{"title":"Update Lead","openapi":"PATCH /leads/{id}","href":"/v3/api-reference/leads/update-a-lead"},{"title":"Delete many leads","deprecated":null,"version":null,"openapi":"/v3/api-reference/openapi.json post /leads/delete-many","href":"/v3/api-reference/leads/delete-many-leads"},{"title":"List leads with pagination and filters","deprecated":null,"version":null,"openapi":"/v3/api-reference/openapi.json post /leads/list","href":"/v3/api-reference/leads/list-leads-with-pagination-and-filters"},{"title":"Connect a lead to a company","deprecated":null,"version":null,"openapi":"/v3/api-reference/openapi.json post /leads/{id_lead}/connect","href":"/v3/api-reference/leads/connect-a-lead-to-a-company"},{"title":"Disconnect a lead from a company","deprecated":null,"version":null,"openapi":"/v3/api-reference/openapi.json post /leads/{id_lead}/disconnect","href":"/v3/api-reference/leads/disconnect-a-lead-from-a-company"},{"title":"Search leads","deprecated":null,"version":null,"openapi":"/v3/api-reference/openapi.json post /leads/search","href":"/v3/api-reference/leads/search-leads"}]},{"group":"Tags","pages":[{"title":"Get a tag by id","deprecated":null,"version":null,"openapi":"/v3/api-reference/openapi.json get /tags/{id}","href":"/v3/api-reference/tags/get-a-tag-by-id"},{"title":"Delete a tag","deprecated":null,"version":null,"openapi":"/v3/api-reference/openapi.json delete /tags/{id}","href":"/v3/api-reference/tags/delete-a-tag"},{"title":"Update a tag","deprecated":null,"version":null,"openapi":"/v3/api-reference/openapi.json patch /tags/{id}","href":"/v3/api-reference/tags/update-a-tag"},{"title":"List tags","deprecated":null,"version":null,"openapi":"/v3/api-reference/openapi.json get /tags","href":"/v3/api-reference/tags/list-tags"},{"title":"Create a tag","deprecated":null,"version":null,"openapi":"/v3/api-reference/openapi.json post /tags","href":"/v3/api-reference/tags/create-a-tag"}]},{"group":"Lists","pages":[{"title":"Add many leads to a list","deprecated":null,"version":null,"openapi":"/v3/api-reference/openapi.json post /lists/{id}/add-leads","href":"/v3/api-reference/lists/add-many-leads-to-a-list"},{"title":"Move many leads to a list","deprecated":null,"version":null,"openapi":"/v3/api-reference/openapi.json post /lists/{id}/move-leads","href":"/v3/api-reference/lists/move-many-leads-to-a-list"},{"title":"Remove many leads from a list","deprecated":null,"version":null,"openapi":"/v3/api-reference/openapi.json post /lists/{id}/remove-leads","href":"/v3/api-reference/lists/remove-many-leads-from-a-list"},{"title":"Get all lists","deprecated":null,"version":null,"openapi":"/v3/api-reference/openapi.json get /lists","href":"/v3/api-reference/lists/get-all-lists"},{"title":"Create a list","deprecated":null,"version":null,"openapi":"/v3/api-reference/openapi.json post /lists","href":"/v3/api-reference/lists/create-a-list"},{"title":"Delete a list","deprecated":null,"version":null,"openapi":"/v3/api-reference/openapi.json delete /lists/{id}","href":"/v3/api-reference/lists/delete-a-list"},{"title":"Update a list","deprecated":null,"version":null,"openapi":"/v3/api-reference/openapi.json patch /lists/{id}","href":"/v3/api-reference/lists/update-a-list"},{"title":"Duplicate a list","deprecated":null,"version":null,"openapi":"/v3/api-reference/openapi.json post /lists/{id}/duplicate","href":"/v3/api-reference/lists/duplicate-a-list"}]},{"group":"Notes","pages":[{"title":"List notes","deprecated":null,"version":null,"openapi":"/v3/api-reference/openapi.json post /notes/list","href":"/v3/api-reference/notes/list-notes"},{"title":"Create a note","deprecated":null,"version":null,"openapi":"/v3/api-reference/openapi.json post /notes","href":"/v3/api-reference/notes/create-a-note"},{"title":"Get a note","deprecated":null,"version":null,"openapi":"/v3/api-reference/openapi.json get /notes/{id}","href":"/v3/api-reference/notes/get-a-note"},{"title":"Delete a note","deprecated":null,"version":null,"openapi":"/v3/api-reference/openapi.json delete /notes/{id}","href":"/v3/api-reference/notes/delete-a-note"},{"title":"Update a note","deprecated":null,"version":null,"openapi":"/v3/api-reference/openapi.json patch /notes/{id}","href":"/v3/api-reference/notes/update-a-note"}]},{"group":"Reminders","pages":[{"title":"List reminders with filters and pagination","deprecated":null,"version":null,"openapi":"/v3/api-reference/openapi.json post /reminders/list","href":"/v3/api-reference/reminders/list-reminders-with-filters-and-pagination"},{"title":"Delete a reminder","deprecated":null,"version":null,"openapi":"/v3/api-reference/openapi.json delete /reminders/{id}","href":"/v3/api-reference/reminders/delete-a-reminder"},{"title":"Update a reminder","deprecated":null,"version":null,"openapi":"/v3/api-reference/openapi.json patch /reminders/{id}","href":"/v3/api-reference/reminders/update-a-reminder"},{"title":"Create a reminder","deprecated":null,"version":null,"openapi":"/v3/api-reference/openapi.json post /reminders","href":"/v3/api-reference/reminders/create-a-reminder"}]},{"group":"Attributes","pages":[{"title":"List attributes","deprecated":null,"version":null,"openapi":"/v3/api-reference/openapi.json get /attributes","href":"/v3/api-reference/attributes/list-attributes"},{"title":"Create an attributes","deprecated":null,"version":null,"openapi":"/v3/api-reference/openapi.json post /attribute","href":"/v3/api-reference/attributes/create-an-attributes"},{"title":"Delete an attribute","deprecated":null,"version":null,"openapi":"/v3/api-reference/openapi.json delete /attributes/{id}","href":"/v3/api-reference/attributes/delete-an-attribute"},{"title":"Update an attribute","deprecated":null,"version":null,"openapi":"/v3/api-reference/openapi.json patch /attributes/{id}","href":"/v3/api-reference/attributes/update-an-attribute"}]}]}]}]},"basePath":"","title":"Create Lead - Breakcold","buildId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","deploymentId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["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","clsx-B2v50t8t.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DJnKvr0g.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BHrrjR1K.js"]}