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

🏗️ CRM Pipeline

PipelineCreate

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
namestringOpcionalExample: Funil de Vendas
descriptionstringOpcionalExample: Pipeline principal
Respostas
200

Requisição processada com sucesso.

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

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

PipelineDelete

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.

idstringObrigatório

Identificador do recurso na rota.

Corpo
objectOpcional
Respostas
200

Requisição processada com sucesso.

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

{}
{}

PipelineList

get
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.

Parâmetros de consulta
pageintegerOpcionalExample: 1
limitintegerOpcionalExample: 20
Respostas
200

Requisição processada com sucesso.

application/json
objectOpcional
get/v2/api/external/{apiId}/pipeline/list
GET /v2/api/external/{apiId}/pipeline/list HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{}

PipelineShow

get
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.

idstringObrigatório

Identificador do recurso na rota.

Respostas
200

Requisição processada com sucesso.

application/json
objectOpcional
get/v2/api/external/{apiId}/pipeline/show/{id}
GET /v2/api/external/{apiId}/pipeline/show/{id} HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{}

PipelineUpdate

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.

idstringObrigatório

Identificador do recurso na rota.

Corpo
namestringOpcionalExample: Funil Atualizado
Respostas
200

Requisição processada com sucesso.

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

{
  "name": "Funil Atualizado"
}
{}

StageCreate

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
namestringOpcionalExample: Prospecção
pipelineIdstringOpcionalExample: {{pipelineId}}
orderintegerOpcionalExample: 1
colorstringOpcionalExample: #00a300
Respostas
200

Requisição processada com sucesso.

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

{
  "name": "Prospecção",
  "pipelineId": "{{pipelineId}}",
  "order": 1,
  "color": "#00a300"
}
{}

StageDelete

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.

idstringObrigatório

Identificador do recurso na rota.

Corpo
objectOpcional
Respostas
200

Requisição processada com sucesso.

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

{}
{}

StageList

get
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.

Parâmetros de consulta
pageintegerOpcionalExample: 1
limitintegerOpcionalExample: 20
pipelineIdstringOpcionalExample: {{pipelineId}}
Respostas
200

Requisição processada com sucesso.

application/json
objectOpcional
get/v2/api/external/{apiId}/stage/list
GET /v2/api/external/{apiId}/stage/list HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{}

StageShow

get
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.

idstringObrigatório

Identificador do recurso na rota.

Respostas
200

Requisição processada com sucesso.

application/json
objectOpcional
get/v2/api/external/{apiId}/stage/show/{id}
GET /v2/api/external/{apiId}/stage/show/{id} HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{}

StageUpdate

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.

idstringObrigatório

Identificador do recurso na rota.

Corpo
namestringOpcionalExample: Qualificação
Respostas
200

Requisição processada com sucesso.

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

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

Atualizado

Isto foi útil?