Referência da API

Negociações

As negociações do funil de vendas, com valor, moeda e etapa.

Listar negociações

get/api/v1/deals

Permissão da chave: leitura

Parâmetros

limit integer · consulta

Padrão: 50 · Máximo: 200

cursor string · consulta

next_cursor da página anterior

updated_since string (date-time) · consulta

—

status string · consulta

—

Respostas

200Página

Requisição

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

Resposta

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

Exemplo ilustrativo.

Criar negociação

post/api/v1/deals

Permissão da chave: escrita

Corpo (JSON)

lead_id string (uuid)obrigatório

—

title stringobrigatório

—

value numberobrigatório

—

currency string

Padrão: BRL

stage string

—

expected_close_at string (date)

—

Respostas

201Criada

Requisição

curl -X POST "https://cyzyra.vercel.app/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"}'

Resposta

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

Exemplo ilustrativo.

AnteriorLeads PróximoObjetos