CRM

Embudo, tarjetas y etapas

POST`/api/crm/cards`

Crear una tarjeta manualmente

Ámbito requerido: crm.cards.write

Cuerpo de la petición

Campo	Tipo	Obligatorio	Restricciones
`pipelineId`	`string`	sí	—
`stageId`	`string`	sí	—
`title`	`string`	sí	min 1, max 200
`value`	`number \| null`	no	—
`contactPhone`	`string`	no	max 30
`contactName`	`string \| null`	no	—
`conversationId`	`stringnull`	no	—
`leadId`	`stringnull`	no	—

bash

curl -X POST "https://api.zapyflow.com.br/api/crm/cards" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

Respuestas

201 — Creado
403 — Prohibido, o la clave no tiene este ámbito
404 — No encontrado — también es la respuesta cuando el recurso es de otro workspace
422 — Entendido, pero rechazado por una regla

PATCH`/api/crm/cards/{id}`

Editar una tarjeta

Ámbito requerido: crm.cards.write

Parámetro	Dónde	Obligatorio
`id`	path	sí

Cuerpo de la petición

Campo	Tipo	Obligatorio	Restricciones
`title`	`string`	no	min 1, max 200
`value`	`number \| null`	no	—
`contactName`	`string \| null`	no	—

bash

curl -X PATCH "https://api.zapyflow.com.br/api/crm/cards/{id}" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

Respuestas

200 — OK
400 — Petición malformada
403 — Prohibido, o la clave no tiene este ámbito
404 — No encontrado — también es la respuesta cuando el recurso es de otro workspace

DELETE`/api/crm/cards/{id}`

Eliminar una tarjeta (la línea de tiempo conserva el historial)

Ámbito requerido: crm.cards.write

Parámetro	Dónde	Obligatorio
`id`	path	sí

bash

curl -X DELETE "https://api.zapyflow.com.br/api/crm/cards/{id}" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"

Respuestas

204 — Sin contenido
403 — Prohibido, o la clave no tiene este ámbito
404 — No encontrado — también es la respuesta cuando el recurso es de otro workspace

POST`/api/crm/cards/{id}/comments`

Comentar en una tarjeta (va a la línea de tiempo de eventos)

Ámbito requerido: crm.cards.write

Parámetro	Dónde	Obligatorio
`id`	path	sí

Cuerpo de la petición

Campo	Tipo	Obligatorio	Restricciones
`body`	`string`	sí	min 1, max 1000

bash

curl -X POST "https://api.zapyflow.com.br/api/crm/cards/{id}/comments" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

Respuestas

201 — Creado
403 — Prohibido, o la clave no tiene este ámbito
404 — No encontrado — también es la respuesta cuando el recurso es de otro workspace

POST`/api/crm/cards/{id}/move`

Mover una tarjeta entre etapas, o reordenarla dentro de una

Ámbito requerido: crm.cards.write

Parámetro	Dónde	Obligatorio
`id`	path	sí

Cuerpo de la petición

Campo	Tipo	Obligatorio	Restricciones
`toStageId`	`string`	sí	—
`beforeCardId`	`stringnull`	no	—
`afterCardId`	`stringnull`	no	—

bash

curl -X POST "https://api.zapyflow.com.br/api/crm/cards/{id}/move" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

Respuestas

200 — OK
400 — Petición malformada
403 — Prohibido, o la clave no tiene este ámbito
404 — No encontrado — también es la respuesta cuando el recurso es de otro workspace

GET`/api/crm/events`

Línea de tiempo de eventos del embudo (el cliente agrupa por día)

Ámbito requerido: crm.read

Parámetro	Dónde	Obligatorio
`pipelineId`	query	sí
`filter`	query	no
`page`	query	no
`limit`	query	no

bash

curl "https://api.zapyflow.com.br/api/crm/events?pipelineId=..." \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"

Respuestas

200 — OK
403 — Prohibido, o la clave no tiene este ámbito
404 — No encontrado — también es la respuesta cuando el recurso es de otro workspace

GET`/api/crm/pipelines`

Listar los embudos del CRM (crea el embudo por defecto en la primera llamada)

Ámbito requerido: crm.read

bash

curl "https://api.zapyflow.com.br/api/crm/pipelines" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"

Respuestas

200 — OK
403 — Prohibido, o la clave no tiene este ámbito

POST`/api/crm/pipelines`

Crear un embudo

Ámbito requerido: crm.structure.write

Cuerpo de la petición

Campo	Tipo	Obligatorio	Restricciones
`name`	`string`	sí	min 1, max 100

bash

curl -X POST "https://api.zapyflow.com.br/api/crm/pipelines" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

Respuestas

201 — Creado
403 — Prohibido, o la clave no tiene este ámbito
422 — Entendido, pero rechazado por una regla

PATCH`/api/crm/pipelines/{id}`

Renombrar un embudo

Ámbito requerido: crm.structure.write

Parámetro	Dónde	Obligatorio
`id`	path	sí

Cuerpo de la petición

Campo	Tipo	Obligatorio	Restricciones
`name`	`string`	sí	min 1, max 100

bash

curl -X PATCH "https://api.zapyflow.com.br/api/crm/pipelines/{id}" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

Respuestas

200 — OK
403 — Prohibido, o la clave no tiene este ámbito
404 — No encontrado — también es la respuesta cuando el recurso es de otro workspace

DELETE`/api/crm/pipelines/{id}`

Eliminar un embudo (el predeterminado no se puede eliminar)

Ámbito requerido: crm.structure.write

Parámetro	Dónde	Obligatorio
`id`	path	sí

bash

curl -X DELETE "https://api.zapyflow.com.br/api/crm/pipelines/{id}" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"

Respuestas

204 — Sin contenido
400 — Petición malformada
403 — Prohibido, o la clave no tiene este ámbito
404 — No encontrado — también es la respuesta cuando el recurso es de otro workspace

GET`/api/crm/pipelines/{id}/board`

El tablero del embudo: etapas ordenadas con tarjetas, recuento y suma

Ámbito requerido: crm.read

Parámetro	Dónde	Obligatorio
`id`	path	sí

bash

curl "https://api.zapyflow.com.br/api/crm/pipelines/{id}/board" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"

Respuestas

200 — OK
403 — Prohibido, o la clave no tiene este ámbito
404 — No encontrado — también es la respuesta cuando el recurso es de otro workspace

GET`/api/crm/reports`

Informes del embudo: KPI, embudo, ventas semanales, origen, ciclo

Ámbito requerido: analytics.read

Parámetro	Dónde	Obligatorio
`pipelineId`	query	sí
`from`	query	no
`to`	query	no

bash

curl "https://api.zapyflow.com.br/api/crm/reports?pipelineId=..." \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"

Respuestas

200 — OK
403 — Prohibido, o la clave no tiene este ámbito
404 — No encontrado — también es la respuesta cuando el recurso es de otro workspace

POST`/api/crm/stages`

Crear una etapa en el embudo

Ámbito requerido: crm.structure.write

Cuerpo de la petición

Campo	Tipo	Obligatorio	Restricciones
`pipelineId`	`string`	sí	—
`name`	`string`	sí	min 1, max 60
`color`	`string`	sí	—

bash

curl -X POST "https://api.zapyflow.com.br/api/crm/stages" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

Respuestas

201 — Creado
403 — Prohibido, o la clave no tiene este ámbito
404 — No encontrado — también es la respuesta cuando el recurso es de otro workspace
422 — Entendido, pero rechazado por una regla

PATCH`/api/crm/stages/{id}`

Editar una etapa

Ámbito requerido: crm.structure.write

Parámetro	Dónde	Obligatorio
`id`	path	sí

Cuerpo de la petición

Campo	Tipo	Obligatorio	Restricciones
`name`	`string`	no	min 1, max 60
`color`	`string`	no	—

bash

curl -X PATCH "https://api.zapyflow.com.br/api/crm/stages/{id}" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

Respuestas

200 — OK
403 — Prohibido, o la clave no tiene este ámbito
404 — No encontrado — también es la respuesta cuando el recurso es de otro workspace

DELETE`/api/crm/stages/{id}`

Eliminar una etapa (vacía, o moviendo sus tarjetas a moveCardsTo)

Ámbito requerido: crm.structure.write

Parámetro	Dónde	Obligatorio
`moveCardsTo`	query	no
`id`	path	sí

bash

curl -X DELETE "https://api.zapyflow.com.br/api/crm/stages/{id}" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"

Respuestas

204 — Sin contenido
400 — Petición malformada
403 — Prohibido, o la clave no tiene este ámbito
404 — No encontrado — también es la respuesta cuando el recurso es de otro workspace

GET`/api/crm/stages/{id}/cards`

Una página de tarjetas de una etapa (el scroll infinito del tablero)

Ámbito requerido: crm.read

Parámetro	Dónde	Obligatorio
`offset`	query	no
`limit`	query	no
`id`	path	sí

bash

curl "https://api.zapyflow.com.br/api/crm/stages/{id}/cards" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"

Respuestas

200 — OK
403 — Prohibido, o la clave no tiene este ámbito
404 — No encontrado — también es la respuesta cuando el recurso es de otro workspace

POST`/api/crm/stages/reorder`

Reordenar las etapas del embudo

Ámbito requerido: crm.structure.write

Cuerpo de la petición

Campo	Tipo	Obligatorio	Restricciones
`pipelineId`	`string`	sí	—
`stageIds`	`string[]`	sí	≥ 1 items

bash

curl -X POST "https://api.zapyflow.com.br/api/crm/stages/reorder" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

Respuestas

204 — Sin contenido
400 — Petición malformada
403 — Prohibido, o la clave no tiene este ámbito
404 — No encontrado — también es la respuesta cuando el recurso es de otro workspace

CRM

POST/api/crm/cards

PATCH/api/crm/cards/{id}

DELETE/api/crm/cards/{id}

POST/api/crm/cards/{id}/comments

POST/api/crm/cards/{id}/move

GET/api/crm/events

GET/api/crm/pipelines

POST/api/crm/pipelines

PATCH/api/crm/pipelines/{id}

DELETE/api/crm/pipelines/{id}

GET/api/crm/pipelines/{id}/board

GET/api/crm/reports

POST/api/crm/stages

PATCH/api/crm/stages/{id}

DELETE/api/crm/stages/{id}

GET/api/crm/stages/{id}/cards

POST/api/crm/stages/reorder

POST`/api/crm/cards`

PATCH`/api/crm/cards/{id}`

DELETE`/api/crm/cards/{id}`

POST`/api/crm/cards/{id}/comments`

POST`/api/crm/cards/{id}/move`

GET`/api/crm/events`

GET`/api/crm/pipelines`

POST`/api/crm/pipelines`

PATCH`/api/crm/pipelines/{id}`

DELETE`/api/crm/pipelines/{id}`

GET`/api/crm/pipelines/{id}/board`

GET`/api/crm/reports`

POST`/api/crm/stages`

PATCH`/api/crm/stages/{id}`

DELETE`/api/crm/stages/{id}`

GET`/api/crm/stages/{id}/cards`

POST`/api/crm/stages/reorder`