Pular para o conteúdo
For the complete documentation index, see llms.txt. This page is also available as Markdown.

💼 Oportunidades

CreateOpportunity

post
Autorizações
AuthorizationstringObrigatório

Token da API do tenant (na coleção Postman: BearerToken).

Parâmetros de rota
apiIdstringObrigatório

ID da API externa cadastrada no Z-PRO.

Corpo
numberstringOpcional

Campos do contato

Example: 5535912345678
contactNamestringOpcional

nome do contato

Example: Nome do Contato
emailstringOpcional

email do contato

Example: contato@email.com
namestringOpcional

Campos da oportunidade

Example: Nome da Oportunidade 2
valuenumberOpcional

valor da oportunidade

Example: 10000
statusstringOpcional

pode ser: "open", "win", "lose"

Example: open
pipelineIdintegerOpcional

ID do pipeline

Example: 16
stageIdintegerOpcional

ID do estágio

Example: 7
responsibleIdintegerOpcional

ID do responsável

Example: 1
closingForecaststringOpcional

data esperada de fechamento

Example: 2024-12-31
descriptionstringOpcional

descrição da oportunidade

Example: Descrição da oportunidade
validateNumberbooleanOpcional

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

Example: true
Respostas
200

Requisição processada com sucesso.

application/json
objectOpcional
post/v2/api/external/{apiId}/createOpportunity
POST /v2/api/external/{apiId}/createOpportunity HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 291

{
  "number": "5535912345678",
  "contactName": "Nome do Contato",
  "email": "contato@email.com",
  "name": "Nome da Oportunidade 2",
  "value": 10000,
  "status": "open",
  "pipelineId": 16,
  "stageId": 7,
  "responsibleId": 1,
  "closingForecast": "2024-12-31",
  "description": "Descrição da oportunidade",
  "validateNumber": true
}
{}

DeleteOpportunity

post
Autorizações
AuthorizationstringObrigatório

Token da API do tenant (na coleção Postman: BearerToken).

Parâmetros de rota
apiIdstringObrigatório

ID da API externa cadastrada no Z-PRO.

Corpo
opportunityIdintegerOpcional

Campos da oportunidade

Example: 19
Respostas
200

Requisição processada com sucesso.

application/json
objectOpcional
post/v2/api/external/{apiId}/deleteOpportunity
POST /v2/api/external/{apiId}/deleteOpportunity HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "opportunityId": 19
}
{}

UpdateOpportunity

post
Autorizações
AuthorizationstringObrigatório

Token da API do tenant (na coleção Postman: BearerToken).

Parâmetros de rota
apiIdstringObrigatório

ID da API externa cadastrada no Z-PRO.

Corpo
opportunityIdintegerOpcional

Campos da oportunidade

Example: 30
namestringOpcional

nome da oportunidade

Example: Nome da Oportunidade 2 API
valuenumberOpcional

valor da oportunidade

Example: 500
statusstringOpcional

pode ser: "open", "win", "lose"

Example: open
pipelineIdintegerOpcional

ID do pipeline

Example: 16
stageIdintegerOpcional

ID do estágio

Example: 7
responsibleIdintegerOpcional

ID do responsável

Example: 1
closingForecaststringOpcional

data esperada de fechamento

Example: 2024-12-31
descriptionstringOpcional

descrição da oportunidade

Example: Descrição da oportunidade
Respostas
200

Requisição processada com sucesso.

application/json
objectOpcional
post/v2/api/external/{apiId}/updateOpportunity
POST /v2/api/external/{apiId}/updateOpportunity HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 205

{
  "opportunityId": 30,
  "name": "Nome da Oportunidade 2 API",
  "value": 500,
  "status": "open",
  "pipelineId": 16,
  "stageId": 7,
  "responsibleId": 1,
  "closingForecast": "2024-12-31",
  "description": "Descrição da oportunidade"
}
{}

Atualizado

Isto foi útil?