{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Kinbox Docs","colors":{"primary":"#367fee","light":"#87abff","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/kinbox/rfT19ZB_LIv08ILX/logo/light.svg?fit=max\u0026auto=format\u0026n=rfT19ZB_LIv08ILX\u0026q=85\u0026s=fa93682e7b102a1661ad9c08e9351d06","dark":"https://mintcdn.com/kinbox/rfT19ZB_LIv08ILX/logo/dark.svg?fit=max\u0026auto=format\u0026n=rfT19ZB_LIv08ILX\u0026q=85\u0026s=9f70dd3e1d3c6ffbabac116d9b284735"},"favicon":"https://mintcdn.com/kinbox/rfT19ZB_LIv08ILX/favicon.png?fit=max\u0026auto=format\u0026n=rfT19ZB_LIv08ILX\u0026q=85\u0026s=a4f8ae78ab46d7a1c4ad02e84f8fe15f","api":{"mdx":{"auth":{"method":"bearer"},"server":"https://platform.kinbox.com.br"}},"navbar":{"links":[{"icon":"whatsapp","href":"https://api.whatsapp.com/send?text=Oi%20preciso%20de%20ajuda\u0026phone=%2B558001151777\u0026type=phone_number\u0026app_absent=0","label":"Suporte"}],"primary":{"type":"button","label":"Abrir Kinbox","href":"https://app.kinbox.com.br"}},"footer":{"socials":{"instagram":"https://www.instagram.com/kinboxoficial","github":"https://github.com/kinboxapp"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"kinbox","hasAudioNarration":false,"actualSubdomain":"kinbox","customDomains":["developer.kinbox.com.br"],"gitSource":{"type":"github","owner":"kinboxapp","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ab53751a89dca91c2bfe5fb","clientVersion":"0.0.4076","searchFilterCounts":[{"language":"default","tag":"API reference","count":53},{"language":"default","tag":"Campanhas","count":8},{"language":"default","tag":"Produtos","count":6},{"language":"default","tag":"Negócios","count":5},{"language":"default","tag":"Funis","count":5},{"language":"default","tag":"Tags","count":5},{"language":"default","tag":"Canais","count":4},{"language":"default","tag":"Contatos","count":4},{"language":"default","tag":"Grupos","count":4},{"language":"default","tag":"Mensagens","count":4}]},"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":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/deals/create-a-deal","slug":"/api-reference/deals/create-a-deal","pageMetadata":{"openapi":"post /v1/deals","title":"Create a deal","description":null,"href":"/api-reference/deals/create-a-deal"},"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 /v1/deals","title":"Create a deal","description":null,"href":"/api-reference/deals/create-a-deal"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"createDeal","parameters":[],"requestBody":"fb1c6bfc-bdea-4745-bb10-cedf7bd96b49","responses":{"201":"30d3862f-1691-4008-99af-97acdb6808f6"},"summary":"Create a deal","tags":["v1Deals"],"method":"post","type":"path","servers":[],"security":[],"path":"/v1/deals","baseUrlOptions":["https://platform.kinbox.com.br"],"title":"Create a deal","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Nome do negócio","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"value":{"type":"number","description":"Valor em dinheiro do negócio","isRequired":true,"uniqueKey":"value","typeLabel":"number"},"status":{"type":"string","enum":["open","won","lost"],"description":"Status do negócio","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"pipelineId":{"type":"string","description":"ID do pipeline associado ao negócio","isRequired":true,"uniqueKey":"pipelineId","typeLabel":"string"},"stageId":{"type":"string","isRequired":true,"uniqueKey":"stageId","typeLabel":"string"},"contactId":{"type":"number","description":"ID do contato associado ao negócio.","isRequired":true,"uniqueKey":"contactId","typeLabel":"number"},"ticketId":{"type":"string","description":"ID sequencial do ticket","uniqueKey":"ticketId","typeLabel":"string"},"description":{"type":"string","description":"Descrição do ticket","uniqueKey":"description","typeLabel":"string"},"slaDueAt":{"format":"date-time","type":"string","description":"Prazo de SLA do ticket","uniqueKey":"slaDueAt","typeLabel":"string\u003cdate-time>"},"lostReason":{"description":"Motivos de perda","type":"array","items":{"type":"string","uniqueKey":"lostReason.items.[INDEX]","typeLabel":"string"},"uniqueKey":"lostReason","typeLabel":"string[]"},"productsLostReason":{"description":"Motivos de perda por produto","type":"array","items":{"type":"object","uniqueKey":"productsLostReason.items.[INDEX]","typeLabel":"object"},"uniqueKey":"productsLostReason","typeLabel":"object[]"},"products":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"products.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"products.items.[INDEX].name","typeLabel":"string"},"price":{"type":"number","isRequired":true,"uniqueKey":"products.items.[INDEX].price","typeLabel":"number"},"quantity":{"type":"number","isRequired":true,"uniqueKey":"products.items.[INDEX].quantity","typeLabel":"number"},"discount":{"type":"number","isRequired":true,"uniqueKey":"products.items.[INDEX].discount","typeLabel":"number"},"discountType":{"type":"string","enum":["percentage","value"],"isRequired":true,"uniqueKey":"products.items.[INDEX].discountType","typeLabel":"enum\u003cstring>"},"total":{"type":"number","isRequired":true,"uniqueKey":"products.items.[INDEX].total","typeLabel":"number"}},"required":["id","name","price","quantity","discount","discountType","total"],"uniqueKey":"products.items.[INDEX]","typeLabel":"object"},"uniqueKey":"products","typeLabel":"object[]"},"lostReasonObs":{"type":"string","description":"Observação de perda","uniqueKey":"lostReasonObs","typeLabel":"string"},"wonLostDate":{"format":"date-time","type":"string","description":"Data de perda ou ganho","uniqueKey":"wonLostDate","typeLabel":"string\u003cdate-time>"},"dueDate":{"format":"date-time","type":"string","description":"Data de vencimento","uniqueKey":"dueDate","typeLabel":"string\u003cdate-time>"},"conversation":{"type":"object","description":"Conversa associada ao negócio","required":["id","platformId","showPending"],"properties":{"id":{"type":"number","isRequired":true,"uniqueKey":"conversation.id","typeLabel":"number"},"platformId":{"type":"number","isRequired":true,"uniqueKey":"conversation.platformId","typeLabel":"number"},"showPending":{"type":"boolean","isRequired":true,"uniqueKey":"conversation.showPending","typeLabel":"boolean"},"lastMessageAt":{"format":"date-time","type":"string","uniqueKey":"conversation.lastMessageAt","typeLabel":"string\u003cdate-time>"},"pendingAt":{"format":"date-time","type":"string","uniqueKey":"conversation.pendingAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"conversation","typeLabel":"object"},"operatorId":{"type":"number","description":"ID do usuário responsável pelo negócio","uniqueKey":"operatorId","typeLabel":"number"},"groupId":{"type":"number","description":"ID do grupo associado ao negócio","uniqueKey":"groupId","typeLabel":"number"},"origin":{"type":"string","uniqueKey":"origin","typeLabel":"string"},"campaign":{"type":"string","uniqueKey":"campaign","typeLabel":"string"},"authorType":{"type":"string","enum":["user","bot","automation","workflow","unknown","cadence","api"],"uniqueKey":"authorType","typeLabel":"enum\u003cstring>"},"authorId":{"type":"object","uniqueKey":"authorId","typeLabel":"object"},"tagIds":{"type":"array","items":{"type":"number","uniqueKey":"tagIds.items.[INDEX]","typeLabel":"number"},"uniqueKey":"tagIds","typeLabel":"number[]"},"position":{"type":"number","uniqueKey":"position","typeLabel":"number"},"focusedCounts":{"type":"number","uniqueKey":"focusedCounts","typeLabel":"number"},"tasks":{"type":"object","additionalProperties":"409b8403-7806-4211-82ae-ac62184ce732","uniqueKey":"tasks","typeLabel":"object"},"timeInStage":{"type":"object","uniqueKey":"timeInStage","typeLabel":"object"},"cadenceOccurrences":{"type":"object","uniqueKey":"cadenceOccurrences","typeLabel":"object"},"lastStageChanged":{"format":"date-time","type":"string","uniqueKey":"lastStageChanged","typeLabel":"string\u003cdate-time>"},"comments":{"type":"number","uniqueKey":"comments","typeLabel":"number"},"context":{"type":"object","properties":{"automationId":{"type":"string","uniqueKey":"context.automationId","typeLabel":"string"},"importId":{"type":"string","uniqueKey":"context.importId","typeLabel":"string"}},"uniqueKey":"context","typeLabel":"object"},"customFields":{"type":"object","additionalProperties":{"type":"object","properties":{"value":{"type":"string","isRequired":true,"uniqueKey":"customFields.additionalProperties.value","typeLabel":"string"},"type":{"type":"string","isRequired":true,"uniqueKey":"customFields.additionalProperties.type","typeLabel":"string"}},"required":["value","type"],"uniqueKey":"customFields.additionalProperties","typeLabel":"object"},"properties":{},"default":{},"uniqueKey":"customFields","typeLabel":"object"}},"required":["name","value","status","pipelineId","stageId","contactId"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","value":123,"pipelineId":"\u003cstring>","stageId":"\u003cstring>","contactId":123,"ticketId":"\u003cstring>","description":"\u003cstring>","slaDueAt":"2023-11-07T05:31:56Z","lostReason":["\u003cstring>"],"productsLostReason":[{}],"products":[{"id":"\u003cstring>","name":"\u003cstring>","price":123,"quantity":123,"discount":123,"total":123}],"lostReasonObs":"\u003cstring>","wonLostDate":"2023-11-07T05:31:56Z","dueDate":"2023-11-07T05:31:56Z","operatorId":123,"groupId":123,"origin":"\u003cstring>","campaign":"\u003cstring>","authorId":{},"tagIds":[123],"position":123,"focusedCounts":123,"tasks":{},"timeInStage":{},"cadenceOccurrences":{},"lastStageChanged":"2023-11-07T05:31:56Z","comments":123,"context":{"automationId":"\u003cstring>","importId":"\u003cstring>"},"customFields":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"30d3862f-1691-4008-99af-97acdb6808f6":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"name":{"type":"string","description":"Nome do negócio","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"value":{"type":"number","description":"Valor em dinheiro do negócio","isRequired":true,"uniqueKey":"value","typeLabel":"number"},"status":{"type":"string","enum":["open","won","lost"],"description":"Status do negócio","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"pipelineId":{"type":"string","description":"ID do pipeline associado ao negócio","isRequired":true,"uniqueKey":"pipelineId","typeLabel":"string"},"stageId":{"type":"string","isRequired":true,"uniqueKey":"stageId","typeLabel":"string"},"ticketId":{"type":"string","description":"ID sequencial do ticket","uniqueKey":"ticketId","typeLabel":"string"},"description":{"type":"string","description":"Descrição do ticket","uniqueKey":"description","typeLabel":"string"},"slaDueAt":{"format":"date-time","type":"string","description":"Prazo de SLA do ticket","uniqueKey":"slaDueAt","typeLabel":"string\u003cdate-time>"},"lostReason":{"description":"Motivos de perda","type":"array","items":{"type":"string","uniqueKey":"lostReason.items.[INDEX]","typeLabel":"string"},"uniqueKey":"lostReason","typeLabel":"string[]"},"productsLostReason":{"description":"Motivos de perda por produto","type":"array","items":{"type":"object","uniqueKey":"productsLostReason.items.[INDEX]","typeLabel":"object"},"uniqueKey":"productsLostReason","typeLabel":"object[]"},"products":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"products.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"products.items.[INDEX].name","typeLabel":"string"},"price":{"type":"number","isRequired":true,"uniqueKey":"products.items.[INDEX].price","typeLabel":"number"},"quantity":{"type":"number","isRequired":true,"uniqueKey":"products.items.[INDEX].quantity","typeLabel":"number"},"discount":{"type":"number","isRequired":true,"uniqueKey":"products.items.[INDEX].discount","typeLabel":"number"},"discountType":{"type":"string","enum":["percentage","value"],"isRequired":true,"uniqueKey":"products.items.[INDEX].discountType","typeLabel":"enum\u003cstring>"},"total":{"type":"number","isRequired":true,"uniqueKey":"products.items.[INDEX].total","typeLabel":"number"}},"required":["id","name","price","quantity","discount","discountType","total"],"uniqueKey":"products.items.[INDEX]","typeLabel":"object"},"uniqueKey":"products","typeLabel":"object[]"},"lostReasonObs":{"type":"string","description":"Observação de perda","uniqueKey":"lostReasonObs","typeLabel":"string"},"wonLostDate":{"format":"date-time","type":"string","description":"Data de perda ou ganho","uniqueKey":"wonLostDate","typeLabel":"string\u003cdate-time>"},"dueDate":{"format":"date-time","type":"string","description":"Data de vencimento","uniqueKey":"dueDate","typeLabel":"string\u003cdate-time>"},"contact":{"type":"object","description":"Contato associado ao negócio","required":["id","name","avatar","phone","email"],"properties":{"id":{"type":"number","isRequired":true,"uniqueKey":"contact.id","typeLabel":"number"},"name":{"type":"string","isRequired":true,"uniqueKey":"contact.name","typeLabel":"string"},"avatar":{"type":"string","isRequired":true,"uniqueKey":"contact.avatar","typeLabel":"string"},"phone":{"type":"string","isRequired":true,"uniqueKey":"contact.phone","typeLabel":"string"},"email":{"type":"string","isRequired":true,"uniqueKey":"contact.email","typeLabel":"string"},"createdAt":{"format":"date-time","type":"string","uniqueKey":"contact.createdAt","typeLabel":"string\u003cdate-time>"},"isPrivate":{"type":"boolean","uniqueKey":"contact.isPrivate","typeLabel":"boolean"}},"uniqueKey":"contact","typeLabel":"object"},"conversation":{"type":"object","description":"Conversa associada ao negócio","required":["id","platformId","showPending"],"properties":{"id":{"type":"number","isRequired":true,"uniqueKey":"conversation.id","typeLabel":"number"},"platformId":{"type":"number","isRequired":true,"uniqueKey":"conversation.platformId","typeLabel":"number"},"showPending":{"type":"boolean","isRequired":true,"uniqueKey":"conversation.showPending","typeLabel":"boolean"},"lastMessageAt":{"format":"date-time","type":"string","uniqueKey":"conversation.lastMessageAt","typeLabel":"string\u003cdate-time>"},"pendingAt":{"format":"date-time","type":"string","uniqueKey":"conversation.pendingAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"conversation","typeLabel":"object"},"operatorId":{"type":"number","description":"ID do usuário responsável pelo negócio","uniqueKey":"operatorId","typeLabel":"number"},"groupId":{"type":"number","description":"ID do grupo associado ao negócio","uniqueKey":"groupId","typeLabel":"number"},"origin":{"type":"string","uniqueKey":"origin","typeLabel":"string"},"campaign":{"type":"string","uniqueKey":"campaign","typeLabel":"string"},"authorType":{"type":"string","enum":["user","bot","automation","workflow","unknown","cadence","api"],"uniqueKey":"authorType","typeLabel":"enum\u003cstring>"},"authorId":{"type":"object","uniqueKey":"authorId","typeLabel":"object"},"tagIds":{"type":"array","items":{"type":"number","uniqueKey":"tagIds.items.[INDEX]","typeLabel":"number"},"uniqueKey":"tagIds","typeLabel":"number[]"},"position":{"type":"number","uniqueKey":"position","typeLabel":"number"},"focusedCounts":{"type":"number","uniqueKey":"focusedCounts","typeLabel":"number"},"tasks":{"type":"object","additionalProperties":"409b8403-7806-4211-82ae-ac62184ce732","uniqueKey":"tasks","typeLabel":"object"},"timeInStage":{"type":"object","uniqueKey":"timeInStage","typeLabel":"object"},"cadenceOccurrences":{"type":"object","uniqueKey":"cadenceOccurrences","typeLabel":"object"},"lastStageChanged":{"format":"date-time","type":"string","uniqueKey":"lastStageChanged","typeLabel":"string\u003cdate-time>"},"comments":{"type":"number","uniqueKey":"comments","typeLabel":"number"},"context":{"type":"object","properties":{"automationId":{"type":"string","uniqueKey":"context.automationId","typeLabel":"string"},"importId":{"type":"string","uniqueKey":"context.importId","typeLabel":"string"}},"uniqueKey":"context","typeLabel":"object"},"customFields":{"type":"object","additionalProperties":{"type":"object","properties":{"value":{"type":"string","isRequired":true,"uniqueKey":"customFields.additionalProperties.value","typeLabel":"string"},"type":{"type":"string","isRequired":true,"uniqueKey":"customFields.additionalProperties.type","typeLabel":"string"}},"required":["value","type"],"uniqueKey":"customFields.additionalProperties","typeLabel":"object"},"properties":{},"default":{},"uniqueKey":"customFields","typeLabel":"object"}},"required":["id","name","value","status","pipelineId","stageId"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","name":"\u003cstring>","value":123,"status":"open","pipelineId":"\u003cstring>","stageId":"\u003cstring>","ticketId":"\u003cstring>","description":"\u003cstring>","slaDueAt":"2023-11-07T05:31:56Z","lostReason":["\u003cstring>"],"productsLostReason":[{}],"products":[{"id":"\u003cstring>","name":"\u003cstring>","price":123,"quantity":123,"discount":123,"discountType":"percentage","total":123}],"lostReasonObs":"\u003cstring>","wonLostDate":"2023-11-07T05:31:56Z","dueDate":"2023-11-07T05:31:56Z","contact":{"id":123,"name":"\u003cstring>","avatar":"\u003cstring>","phone":"\u003cstring>","email":"\u003cstring>","createdAt":"2023-11-07T05:31:56Z","isPrivate":true},"conversation":{"id":123,"platformId":123,"showPending":true,"lastMessageAt":"2023-11-07T05:31:56Z","pendingAt":"2023-11-07T05:31:56Z"},"operatorId":123,"groupId":123,"origin":"\u003cstring>","campaign":"\u003cstring>","authorType":"user","authorId":{},"tagIds":[123],"position":123,"focusedCounts":123,"tasks":{},"timeInStage":{},"cadenceOccurrences":{},"lastStageChanged":"2023-11-07T05:31:56Z","comments":123,"context":{"automationId":"\u003cstring>","importId":"\u003cstring>"},"customFields":{}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"e4d1bee4-3520-4f03-b295-d41fcb4c0409":{"Authorization":{"type":"http","scheme":"bearer","description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token."}}},"servers":{},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token."},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"Authorization","name":"Authorization"}],"title":"Authorization"}]},"originalFileLocation":"openapi.json"},"subdomain":"kinbox","siteName":"Kinbox Docs","title":"Create a deal - Kinbox Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-24T14:44:41.267Z","originalFileLocation":"api-reference/deals/create-a-deal.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=\"Kinbox Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/kinbox/N2Me7JDxF3wwPtrk/_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/kinbox/N2Me7JDxF3wwPtrk/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/kinbox/N2Me7JDxF3wwPtrk/_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/kinbox/N2Me7JDxF3wwPtrk/_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/kinbox/N2Me7JDxF3wwPtrk/_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/kinbox/N2Me7JDxF3wwPtrk/_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/kinbox/N2Me7JDxF3wwPtrk/_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/kinbox/N2Me7JDxF3wwPtrk/_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/kinbox/N2Me7JDxF3wwPtrk/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a deal - Kinbox Docs\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Kinbox Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.kinbox.com.br/api-reference/deals/create-a-deal\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://kinbox.mintlify.site/_mintlify/api/og/v2?division=Neg%C3%B3cios\u0026amp;title=Create+a+deal\u0026amp;theme=913137be1e95efb95a5b7d76\u0026amp;signature=dde05e9ea47e5f68a936ed19a020c99ff459273d0e505de2f24cef1d3fd3a307\">\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 a deal - Kinbox Docs\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://kinbox.mintlify.site/_mintlify/api/og/v2?division=Neg%C3%B3cios\u0026amp;title=Create+a+deal\u0026amp;theme=913137be1e95efb95a5b7d76\u0026amp;signature=dde05e9ea47e5f68a936ed19a020c99ff459273d0e505de2f24cef1d3fd3a307\">\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/kinbox/N2Me7JDxF3wwPtrk/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Kinbox Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#367fee\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.kinbox.com.br/api-reference/deals/create-a-deal\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/deals/create-a-deal.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.kinbox.com.br/#organization\",\"name\":\"Kinbox Docs\",\"url\":\"https://developer.kinbox.com.br\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/kinbox/rfT19ZB_LIv08ILX/logo/light.svg?fit=max\u0026auto=format\u0026n=rfT19ZB_LIv08ILX\u0026q=85\u0026s=fa93682e7b102a1661ad9c08e9351d06\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.kinbox.com.br#website\",\"name\":\"Kinbox Docs\",\"url\":\"https://developer.kinbox.com.br\",\"publisher\":{\"@id\":\"https://developer.kinbox.com.br/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.kinbox.com.br/api-reference/deals/create-a-deal#webpage\",\"url\":\"https://developer.kinbox.com.br/api-reference/deals/create-a-deal\",\"name\":\"Create a deal\",\"dateModified\":\"2026-09-24T14:44:41.267Z\",\"isPartOf\":{\"@id\":\"https://developer.kinbox.com.br#website\"},\"breadcrumb\":{\"@id\":\"https://developer.kinbox.com.br/api-reference/deals/create-a-deal#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.kinbox.com.br/api-reference/deals/create-a-deal#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Negócios\",\"item\":\"https://developer.kinbox.com.br/api-reference/deals/list-all-deals\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a deal\",\"item\":\"https://developer.kinbox.com.br/api-reference/deals/create-a-deal\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.kinbox.com.br/api-reference/deals/create-a-deal#apireference\",\"headline\":\"Create a deal\",\"name\":\"Create a deal\",\"url\":\"https://developer.kinbox.com.br/api-reference/deals/create-a-deal\",\"mainEntityOfPage\":{\"@id\":\"https://developer.kinbox.com.br/api-reference/deals/create-a-deal#webpage\"},\"dateModified\":\"2026-09-24T14:44:41.267Z\",\"publisher\":{\"@id\":\"https://developer.kinbox.com.br/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.kinbox.com.br#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Kinbox Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Kinbox Docs","nav":{"global":null,"tabs":[{"tab":"API reference","groups":[{"group":"API documentation","pages":[{"title":"Autenticação","href":"/api-reference/authentication"},{"title":"Campos personalizados","href":"/api-reference/custom-fields"}]},{"group":"Contatos","icon":"address-card","pages":[{"openapi":"get /v1/contacts","title":"List all contacts","href":"/api-reference/contacts/list-all-contacts"},{"openapi":"get /v1/contacts/{id}","title":"Retrieve a contact","href":"/api-reference/contacts/retrieve-a-contact"},{"openapi":"post /v1/contacts","title":"Create a contact","href":"/api-reference/contacts/create-a-contact"},{"openapi":"patch /v1/contacts/{id}","title":"Update a contact","href":"/api-reference/contacts/update-a-contact"}]},{"group":"Campos personalizados","icon":"keyboard","pages":[{"openapi":"get /v1/custom-fields","title":"List all custom fields","href":"/api-reference/custom-fields/list-all-custom-fields"},{"openapi":"get /v1/custom-fields/{id}","title":"Retrieve a custom field","href":"/api-reference/custom-fields/retrieve-a-custom-field"}]},{"group":"Tags","icon":"tags","pages":[{"openapi":"get /v1/tags","title":"List all tags","href":"/api-reference/tags/list-all-tags"},{"openapi":"get /v1/tags/{id}","title":"Retrieve a tag","href":"/api-reference/tags/retrieve-a-tag"},{"openapi":"post /v1/tags","title":"Create a tag","href":"/api-reference/tags/create-a-tag"},{"openapi":"patch /v1/tags/{id}","title":"Update a tag","href":"/api-reference/tags/update-a-tag"},{"openapi":"delete /v1/tags/{id}","title":"Delete a tag","href":"/api-reference/tags/delete-a-tag"}]},{"group":"Produtos","icon":"barcode","pages":[{"openapi":"get /v1/products","title":"List all products","href":"/api-reference/products/list-all-products"},{"openapi":"get /v1/products/{id}","title":"Retrieve a product","href":"/api-reference/products/retrieve-a-product"},{"openapi":"post /v1/products","title":"Create a product","href":"/api-reference/products/create-a-product"},{"openapi":"patch /v1/products/{id}","title":"Update a product","href":"/api-reference/products/update-a-product"},{"openapi":"delete /v1/products/{id}","title":"Delete a product","href":"/api-reference/products/delete-a-product"},{"openapi":"get /v1/products/external/{externalId}","title":"Retrieve a product by external id","href":"/api-reference/products/retrieve-a-product-by-external-id"}]},{"group":"Negócios","icon":"badge-dollar","pages":[{"openapi":"get /v1/deals","title":"List all deals","href":"/api-reference/deals/list-all-deals"},{"openapi":"get /v1/deals/{id}","title":"Retrieve a deal","description":null,"href":"/api-reference/deals/retrieve-a-deal"},{"openapi":"post /v1/deals","title":"Create a deal","href":"/api-reference/deals/create-a-deal"},{"openapi":"patch /v1/deals/{id}","title":"Update a deal","description":null,"href":"/api-reference/deals/update-a-deal"},{"openapi":"delete /v1/deals/{id}","title":"Delete a deal","href":"/api-reference/deals/delete-a-deal"}]},{"group":"Funis","icon":"filter","pages":[{"openapi":"get /v1/pipelines","title":"List all pipelines","href":"/api-reference/pipelines/list-all-pipelines"},{"openapi":"get /v1/pipelines/{id}","title":"Retrieve a pipeline","href":"/api-reference/pipelines/retrieve-a-pipeline"},{"openapi":"post /v1/pipelines","title":"Create a pipeline","href":"/api-reference/pipelines/create-a-pipeline"},{"openapi":"patch /v1/pipelines/{id}","title":"Update a pipeline","href":"/api-reference/pipelines/update-a-pipeline"},{"openapi":"delete /v1/pipelines/{id}","title":"Delete a pipeline","href":"/api-reference/pipelines/delete-a-pipeline"}]},{"group":"Campanhas","icon":"bullseye-arrow","pages":[{"openapi":"get /v1/campaigns","title":"List all campaigns","href":"/api-reference/campaigns/list-all-campaigns"},{"openapi":"get /v1/campaigns/{id}","title":"Retrieve a campaign","href":"/api-reference/campaigns/retrieve-a-campaign"},{"openapi":"post /v1/campaigns","title":"Create a campaign","href":"/api-reference/campaigns/create-a-campaign"},{"openapi":"patch /v1/campaigns/{id}","title":"Update a campaign","href":"/api-reference/campaigns/update-a-campaign"},{"openapi":"delete /v1/campaigns/{id}","title":"Delete a campaign","href":"/api-reference/campaigns/delete-a-campaign"},{"openapi":"post /v1/campaigns/{id}/pause","title":"Pause a campaign","href":"/api-reference/campaigns/pause-a-campaign"},{"openapi":"post /v1/campaigns/{id}/resume","title":"Resume a campaign","href":"/api-reference/campaigns/resume-a-campaign"},{"openapi":"get /v1/campaigns/{id}/chunk-leads","title":"Get campaign leads","href":"/api-reference/campaigns/get-campaign-leads"}]},{"group":"Sessões","icon":"comments","pages":[{"openapi":"get /v1/sessions","title":"List all sessions","href":"/api-reference/sessions/list-all-sessions"},{"openapi":"get /v1/sessions/{id}","title":"Retrieve a session","href":"/api-reference/sessions/retrieve-a-session"}]},{"group":"Mensagens","icon":"message","pages":[{"openapi":"post /v1/messages/send","title":"Send a message","href":"/api-reference/messages/send-a-message"},{"openapi":"get /v1/messages/queue/{id}","title":"Retrieve queued message status","href":"/api-reference/messages/retrieve-queued-message-status"},{"openapi":"get /v1/messages/{id}","title":"Retrieve a message","href":"/api-reference/messages/retrieve-a-message"},{"openapi":"get /v1/conversations/{id}/messages","title":"List conversation messages","href":"/api-reference/messages/list-conversation-messages"}]},{"group":"Canais","icon":"plug","pages":[{"openapi":"get /v1/channels","title":"List all channels","href":"/api-reference/channels/list-all-channels"},{"openapi":"get /v1/channels/{id}","title":"Retrieve a channel","href":"/api-reference/channels/retrieve-a-channel"},{"openapi":"get /v1/channels/{id}/templates","title":"List channel templates","href":"/api-reference/channels/list-channel-templates"},{"openapi":"get /v1/channels/{id}/check-whatsapp","title":"Check if a phone has WhatsApp","href":"/api-reference/channels/check-if-a-phone-has-whatsapp"}]},{"group":"Grupos","icon":"users","pages":[{"openapi":"get /v1/groups","title":"List all groups","href":"/api-reference/groups/list-all-groups"},{"openapi":"get /v1/groups/{id}","title":"Retrieve a group","href":"/api-reference/groups/retrieve-a-group"},{"openapi":"get /v1/groups/{id}/users","title":"List group users","href":"/api-reference/groups/list-group-users"},{"openapi":"get /v1/groups/{id}/users/{userId}","title":"Retrieve a group user","href":"/api-reference/groups/retrieve-a-group-user"}]},{"group":"Frases rápidas","icon":"bolt","pages":[{"openapi":"get /v1/quick-phrases","title":"List all quick phrases","href":"/api-reference/quick-phrases/list-all-quick-phrases"},{"openapi":"get /v1/quick-phrases/{id}","title":"Retrieve a quick phrase","href":"/api-reference/quick-phrases/retrieve-a-quick-phrase"}]}]}]},"basePath":"","title":"Create a deal - Kinbox Docs","buildId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","deploymentId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-i2a3QZ8E.js","utils-ChLwp8m0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DRktVTDc.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CA2pEs4T.js","snippetPresets-ClQ6XrKD.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-BUDYNlhG.js","ApiExamples-Ct_Lv36y.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Cn2PYw9e.js","shallow-rkyymjXQ.js","getApiPlaygroundDisplay-BB9vkXtE.js","CodeSnippet-Bm5RU7m1.js","CodeSnippets-BgU9Deuz.js","getPastedJson-BD-6NNum.js","icon-8Z6tud2e.js","MethodPill-Tuzr4g3V.js","DuplicateIcon-0ceWFYhN.js","createIcon-FBXow_ST.js","DynamicMarkdown-CD8713Yy.js","SectionHeading-7zgzQbH-.js","axios-vUo_bRtp.js","Markdown-D7Ofw1oz.js","clsx-eKJ4rcii.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CwjSCXIK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-9EK5IAXV.js"]}