🏗️ CRM Pipeline

PipelineCreate

post

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

/v2/api/external/{ApiID}/pipeline/create

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

namestringOpcional

descriptionstringOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/pipeline/create

HTTPcURLJavaScriptPython

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

{
  "name": "Funil de Vendas",
  "description": "Pipeline principal"
}

200

Successful response

PipelineDelete

post

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

/v2/api/external/{ApiID}/pipeline/delete/{id}

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

idstringObrigatório

Corpo

application/json

objectOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/pipeline/delete/{id}

HTTPcURLJavaScriptPython

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

{}

200

Successful response

PipelineList

get

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

/v2/api/external/{ApiID}/pipeline/list

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Parâmetros de consulta

pageintegerOpcionalExample: 1

limitintegerOpcionalExample: 20

Respostas

200

Successful response

application/json

get/v2/api/external/{ApiID}/pipeline/list

HTTPcURLJavaScriptPython

GET /v2/api/external/{ApiID}/pipeline/list HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

PipelineShow

get

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

/v2/api/external/{ApiID}/pipeline/show/{id}

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

idstringObrigatório

Respostas

200

Successful response

application/json

get/v2/api/external/{ApiID}/pipeline/show/{id}

HTTPcURLJavaScriptPython

GET /v2/api/external/{ApiID}/pipeline/show/{id} HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

PipelineUpdate

post

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

/v2/api/external/{ApiID}/pipeline/update/{id}

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

idstringObrigatório

Corpo

application/json

namestringOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/pipeline/update/{id}

HTTPcURLJavaScriptPython

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

{
  "name": "Funil Atualizado"
}

200

Successful response

StageCreate

post

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

/v2/api/external/{ApiID}/stage/create

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

namestringOpcional

pipelineIdstringOpcional

ordernumberOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/stage/create

HTTPcURLJavaScriptPython

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

{
  "name": "Prospecção",
  "pipelineId": "{{pipelineId}}",
  "order": 1
}

200

Successful response

StageDelete

post

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

/v2/api/external/{ApiID}/stage/delete/{id}

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

idstringObrigatório

Corpo

application/json

objectOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/stage/delete/{id}

HTTPcURLJavaScriptPython

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

{}

200

Successful response

StageList

get

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

/v2/api/external/{ApiID}/stage/list

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Parâmetros de consulta

pageintegerOpcionalExample: 1

limitintegerOpcionalExample: 20

pipelineIdstringOpcionalExample: {{pipelineId}}

Respostas

200

Successful response

application/json

get/v2/api/external/{ApiID}/stage/list

HTTPcURLJavaScriptPython

GET /v2/api/external/{ApiID}/stage/list HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

StageShow

get

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

/v2/api/external/{ApiID}/stage/show/{id}

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

idstringObrigatório

Respostas

200

Successful response

application/json

get/v2/api/external/{ApiID}/stage/show/{id}

HTTPcURLJavaScriptPython

GET /v2/api/external/{ApiID}/stage/show/{id} HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

StageUpdate

post

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

/v2/api/external/{ApiID}/stage/update/{id}

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

idstringObrigatório

Corpo

application/json

namestringOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/stage/update/{id}

HTTPcURLJavaScriptPython

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

{
  "name": "Qualificação"
}

200

Successful response