💼 Oportunidades

POST /v2/api/external/{apiId}/createOpportunity

CreateOpportunity

{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"💼 Oportunidades"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Connect.ai do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Connect.ai, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do conta (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Connect.ai.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/createOpportunity":{"post":{"tags":["💼 Oportunidades"],"summary":"CreateOpportunity","operationId":"CreateOpportunity","parameters":[{"$ref":"#/components/parameters/ApiId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"number":{"type":"string","description":"Campos do contato"},"contactName":{"type":"string","description":"nome do contato"},"email":{"type":"string","description":"email do contato"},"name":{"type":"string","description":"Campos da oportunidade"},"value":{"type":"number","description":"valor da oportunidade"},"status":{"type":"string","description":"pode ser: \"open\", \"win\", \"lose\""},"pipelineId":{"type":"integer","description":"ID do pipeline"},"stageId":{"type":"integer","description":"ID do estágio"},"responsibleId":{"type":"integer","description":"ID do responsável"},"closingForecast":{"type":"string","description":"data esperada de fechamento"},"description":{"type":"string","description":"descrição da oportunidade"},"validateNumber":{"type":"boolean","description":"Validar numero (opcional, padrao true). Se false, usa o numero exatamente como enviado, sem normalizacao do 9o digito BR — recomendado p/ WABA evitar ticket duplicado"}}}}}},"responses":{"200":{"description":"Requisição processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Parâmetros inválidos ou faltando."},"401":{"description":"Token ausente, inválido ou sem permissão."}}}}}}

POST /v2/api/external/{apiId}/deleteOpportunity

DeleteOpportunity

{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"💼 Oportunidades"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Connect.ai do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Connect.ai, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do conta (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Connect.ai.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/deleteOpportunity":{"post":{"tags":["💼 Oportunidades"],"summary":"DeleteOpportunity","operationId":"DeleteOpportunity","parameters":[{"$ref":"#/components/parameters/ApiId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"opportunityId":{"type":"integer","description":"Campos da oportunidade"}}}}}},"responses":{"200":{"description":"Requisição processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Parâmetros inválidos ou faltando."},"401":{"description":"Token ausente, inválido ou sem permissão."}}}}}}

POST /v2/api/external/{apiId}/updateOpportunity

UpdateOpportunity

{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"💼 Oportunidades"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Connect.ai do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Connect.ai, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do conta (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Connect.ai.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/updateOpportunity":{"post":{"tags":["💼 Oportunidades"],"summary":"UpdateOpportunity","operationId":"UpdateOpportunity","parameters":[{"$ref":"#/components/parameters/ApiId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"opportunityId":{"type":"integer","description":"Campos da oportunidade"},"name":{"type":"string","description":"nome da oportunidade"},"value":{"type":"number","description":"valor da oportunidade"},"status":{"type":"string","description":"pode ser: \"open\", \"win\", \"lose\""},"pipelineId":{"type":"integer","description":"ID do pipeline"},"stageId":{"type":"integer","description":"ID do estágio"},"responsibleId":{"type":"integer","description":"ID do responsável"},"closingForecast":{"type":"string","description":"data esperada de fechamento"},"description":{"type":"string","description":"descrição da oportunidade"}}}}}},"responses":{"200":{"description":"Requisição processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Parâmetros inválidos ou faltando."},"401":{"description":"Token ausente, inválido ou sem permissão."}}}}}}

Este artigo foi útil?