Referência da API

Leads

Contatos e clientes. A criação não duplica: e-mail ou telefone iguais devolvem o lead que já existe.

Listar leads

get/api/v1/leads

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 de leads

Requisição

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

Resposta

{
  "data": [
    {
      "id": "8f1c…",
      "name": "Ana Souza",
      "email": "ana@example.com",
      "status": "new",
      "created_at": "2026-11-08T14:02:11Z"
    }
  ],
  "next_cursor": "eyJ0Ijoi…"
}

Illustratief voorbeeld.

Criar lead (sem duplicar: e-mail/telefone iguais devolvem o existente)

post/api/v1/leads

Permissão da chave: escrita

Corpo (JSON)

name stringobrigatório

—

email string

—

phone string

—

whatsapp string

—

city string

—

country string

Exemplo: "BR"

notes string

—

source_detail string

—

tags string[]

—

Respostas

200Já existia (duplicate: true)
201Criado

Requisição

curl -X POST "https://www.cyzyra.com/api/v1/leads" \
  -H "Authorization: Bearer $CYZYRA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Ana Souza","email":"ana@example.com","whatsapp":"+5511999990000","country":"BR","tags":["site"]}'

Resposta

{
  "data": {
    "id": "8f1c…",
    "name": "Ana Souza",
    "status": "new"
  },
  "created": true,
  "duplicate": false
}

Illustratief voorbeeld.

Ver lead

get/api/v1/leads/{id}

Permissão da chave: leitura

Parâmetros

id string (uuid) · caminhoobrigatório

—

Respostas

200Lead
404Não encontrado

Requisição

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

Resposta

{
  "data": {
    "id": "8f1c…",
    "name": "Ana Souza",
    "email": "ana@example.com",
    "status": "new"
  }
}

Illustratief voorbeeld.

Alterar lead

patch/api/v1/leads/{id}

Permissão da chave: escrita

Parâmetros

id string (uuid) · caminhoobrigatório

—

Corpo (JSON)

name string

—

email string

—

phone string

—

city string

—

status string

—

tags string[]

—

notes string

—

do_not_contact boolean

—

Respostas

200Lead atualizado

Requisição

curl -X PATCH "https://www.cyzyra.com/api/v1/leads/LEAD_ID" \
  -H "Authorization: Bearer $CYZYRA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"city":"Curitiba","tags":["vip"]}'

Resposta

{
  "data": {
    "id": "8f1c…",
    "city": "Curitiba",
    "tags": [
      "vip"
    ]
  }
}

Illustratief voorbeeld.

AnteriorPaginação PróximoNegociações