Etapas do funil — API Zyron Connect Suite

Primeros pasos

Módulo

Etapas del embudo

Gestiona las columnas del embudo usadas en el CRM.

GET/stages/stages POST/stages/stages PATCH/stages/:id/stages/:id DELETE/stages/:id/stages/:id

GET/stagesAlcance: readOficial + Básico

Lista etapas ordenadas por posición.

Úsalo antes de mover contactos para descubrir IDs válidos.

Parámetros de ruta

Sin parámetros adicionales.

Parámetros de query

Sin parámetros adicionales.

Campos del cuerpo

Este endpoint no recibe cuerpo JSON.

Ejemplos listos

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

Respuestas

200	Etapas devueltas.

Ejemplo de respuesta

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

POST/stagesAlcance: writeOficial + Básico

Crea una nueva etapa.

La nueva etapa entra después de la última posición existente.

Parámetros de ruta

Sin parámetros adicionales.

Parámetros de query

Sin parámetros adicionales.

Campos del cuerpo

Campo	Tipo	Descripción
`name`obligatorio	string	Nombre de la etapa, hasta 40 caracteres.
`color`opcional	string	Color hexadecimal. Predeterminado #5b9bd9.

Ejemplos listos

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"
}'

Respuestas

201	Etapa creada.
422	name ausente.

Ejemplo de respuesta

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

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

Actualiza nombre, color o posición.

Envía al menos un campo. La posición se normaliza a entero mayor o igual a cero.

Parámetros de ruta

Campo	Tipo	Descripción
`id`obligatorio	uuid	ID de la etapa.

Parámetros de query

Sin parámetros adicionales.

Campos del cuerpo

Campo	Tipo	Descripción
`name`opcional	string	Nuevo nombre de la etapa.
`color`opcional	string	Nuevo color hexadecimal.
`position`opcional	number	Nueva posición en el embudo.

Ejemplos listos

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
}'

Respuestas

200	Etapa actualizada.
422	Ningún campo enviado o nombre inválido.

Ejemplo de respuesta

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

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

Elimina una etapa del embudo.

La API mantiene al menos una etapa. Contactos de la etapa eliminada vuelven a derivación automática.

Parámetros de ruta

Campo	Tipo	Descripción
`id`obligatorio	uuid	ID de la etapa.

Parámetros de query

Sin parámetros adicionales.

Campos del cuerpo

Este endpoint no recibe cuerpo JSON.

Ejemplos listos

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

Respuestas

200	Etapa eliminada.
422	Intento de eliminar la última etapa.

Ejemplo de respuesta

{
  "deleted": true
}