Referencia API

Negociaciones

Negociaciones del embudo de ventas, con valor, moneda y etapa.

Listar negociações

get/api/v1/deals

Permiso clave: leitura

Parámetros

limit integer · consulta

Predeterminado: 50 · Máximo: 200

cursor string · consulta

next_cursor da página anterior

updated_since string (date-time) · consulta

—

status string · consulta

—

Respuestas

200Página

Pedido

curl "https://www.cyzyra.com/api/v1/deals" \
  -H "Authorization: Bearer $CYZYRA_API_KEY"

Respuesta

{
  "data": [
    {
      "id": "c21a…",
      "title": "Plano anual",
      "value": 1500,
      "currency": "BRL"
    }
  ],
  "next_cursor": null
}

Illustratief voorbeeld.

Criar negociação

post/api/v1/deals

Permiso clave: escrita

Cuerpo (JSON)

lead_id string (uuid)obligatorio

—

title stringobligatorio

—

value numberobligatorio

—

currency string

Predeterminado: BRL

stage string

—

expected_close_at string (date)

—

Respuestas

201Criada

Pedido

curl -X POST "https://www.cyzyra.com/api/v1/deals" \
  -H "Authorization: Bearer $CYZYRA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"lead_id":"LEAD_ID","title":"Plano anual","value":1500,"currency":"BRL"}'

Respuesta

{
  "data": {
    "id": "c21a…",
    "title": "Plano anual",
    "value": 1500,
    "currency": "BRL"
  }
}

Illustratief voorbeeld.

AnteriorDirige PróximoObjetos