Référence API

Négociations

Négociations de l'entonnoir de vente, avec valeur, devise et étape.

Listar negociações

get/api/v1/deals

Autorisation de clé : leitura

Paramètres

limit integer · consulta

Par défaut : 50 · Máximo: 200

cursor string · consulta

next_cursor da página anterior

updated_since string (date-time) · consulta

—

status string · consulta

—

Réponses

200Page

Demande

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

Réponse

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

Açıklayıcı örnek.

Criar negociação

post/api/v1/deals

Autorisation de clé : escrita

Corps (JSON)

lead_id string (uuid)obligatoire

—

title stringobligatoire

—

value numberobligatoire

—

currency string

Par défaut : BRL

stage string

—

expected_close_at string (date)

—

Réponses

201Criada

Demande

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

Réponse

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

Açıklayıcı örnek.

PrécédentConduit SuivantObjets