💼 Oportunidades

CreateOpportunity

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/createOpportunity

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

numberstringOpcional

contactNamestringOpcional

emailstringOpcional

namestringOpcional

valuenumberOpcional

statusstringOpcional

pipelineIdnumberOpcional

stageIdnumberOpcional

responsibleIdnumberOpcional

closingForecaststringOpcional

descriptionstringOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/createOpportunity

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/createOpportunity HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 269

{
  "number": "5535912345678",
  "contactName": "Nome do Contato",
  "email": "[e-mail]",
  "name": "Nome da Oportunidade 2",
  "value": 10000,
  "status": "open",
  "pipelineId": 16,
  "stageId": 7,
  "responsibleId": 1,
  "closingForecast": "2024-12-31",
  "description": "Descrição da oportunidade"
}

200

Successful response

DeleteOpportunity

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/deleteOpportunity

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

opportunityIdnumberOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/deleteOpportunity

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/deleteOpportunity HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "opportunityId": 19
}

200

Successful response

UpdateOpportunity

post

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/updateOpportunity

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

opportunityIdnumberOpcional

namestringOpcional

valuenumberOpcional

statusstringOpcional

pipelineIdnumberOpcional

stageIdnumberOpcional

responsibleIdnumberOpcional

closingForecaststringOpcional

descriptionstringOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/updateOpportunity

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/updateOpportunity HTTP/1.1
Host: {{baseurl}}
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"
}

200

Successful response