Etapas do funil

Primeiros passos

Módulo

Gerencie as colunas do funil usadas no CRM.

GETListar etapas/stages POSTCriar etapa/stages PATCHAtualizar etapa/stages/:id DELETERemover etapa/stages/:id

GET/stagesEscopo: readOficial + Básico

Lista etapas ordenadas por posição.

Use antes de mover contatos para descobrir os IDs válidos de etapa.

Parâmetros de caminho

Sem parâmetros adicionais.

Parâmetros de query

Sem parâmetros adicionais.

Campos do corpo

Este endpoint não recebe corpo JSON.

Exemplos prontos

curl -X GET "https://connect.zyronstack.com/api/v1/stages" \
  -H "Authorization: Bearer SUA_CHAVE_API"

Respostas

200	Etapas retornadas.

Exemplo de resposta

{
  "data": [
    {
      "id": "<STAGE_ID>",
      "name": "Negociando",
      "position": 2,
      "color": "#D9982F",
      "auto_kind": null,
      "created_at": "2026-06-15T12:30:00.000Z"
    }
  ]
}

POST/stagesEscopo: writeOficial + Básico

Cria uma nova etapa.

A nova etapa entra após a última posição existente.

Parâmetros de caminho

Sem parâmetros adicionais.

Parâmetros de query

Sem parâmetros adicionais.

Campos do corpo

Campo	Tipo	Descrição
`name`obrigatório	string	Nome da etapa, até 40 caracteres.
`color`opcional	string	Cor em hexadecimal. Padrão #5b9bd9.

Exemplos prontos

curl -X POST "https://connect.zyronstack.com/api/v1/stages" \
  -H "Authorization: Bearer SUA_CHAVE_API" \
  -H "content-type: application/json" \
  -d '{
  "name": "Negociando",
  "color": "#D9982F"
}'

Respostas

201	Etapa criada.
422	name ausente.

Exemplo de resposta

{
  "data": {
    "id": "<STAGE_ID>",
    "name": "Negociando",
    "position": 2,
    "color": "#D9982F",
    "auto_kind": null,
    "created_at": "2026-06-15T12:30:00.000Z"
  }
}

PATCH/stages/:idEscopo: writeOficial + Básico

Atualiza nome, cor ou posição.

Envie ao menos um campo. A posição é normalizada para número inteiro maior ou igual a zero.

Parâmetros de caminho

Campo	Tipo	Descrição
`id`obrigatório	uuid	ID da etapa.

Parâmetros de query

Sem parâmetros adicionais.

Campos do corpo

Campo	Tipo	Descrição
`name`opcional	string	Novo nome da etapa.
`color`opcional	string	Nova cor hexadecimal.
`position`opcional	number	Nova posição no funil.

Exemplos prontos

curl -X PATCH "https://connect.zyronstack.com/api/v1/stages/<STAGE_ID>" \
  -H "Authorization: Bearer SUA_CHAVE_API" \
  -H "content-type: application/json" \
  -d '{
  "name": "Proposta enviada",
  "color": "#5B9BD9",
  "position": 3
}'

Respostas

200	Etapa atualizada.
422	Nenhum campo enviado ou nome inválido.

Exemplo de resposta

{
  "data": {
    "id": "<STAGE_ID>",
    "name": "Proposta enviada",
    "position": 3,
    "color": "#5B9BD9",
    "auto_kind": null,
    "created_at": "2026-06-15T12:30:00.000Z"
  }
}

DELETE/stages/:idEscopo: writeOficial + Básico

Remove uma etapa do funil.

A API mantém ao menos uma etapa. Contatos da etapa removida voltam à derivação automática.

Parâmetros de caminho

Campo	Tipo	Descrição
`id`obrigatório	uuid	ID da etapa.

Parâmetros de query

Sem parâmetros adicionais.

Campos do corpo

Este endpoint não recebe corpo JSON.

Exemplos prontos

curl -X DELETE "https://connect.zyronstack.com/api/v1/stages/<STAGE_ID>" \
  -H "Authorization: Bearer SUA_CHAVE_API"

Respostas

200	Etapa removida.
422	Tentativa de remover a última etapa.

Exemplo de resposta

{
  "deleted": true
}