Developers

Aparência

Vai integrar a API REST da Zarv com ajuda de IA? Copie a instrução que aponta o modelo para esta documentação.
Ver a instrução
Você vai integrar a API REST da Zarv. Use a documentação oficial como fonte da verdade.

- Página desta integração: https://developers.zarv.com/api/smartflow/createLead
- Autenticação Bearer JWT e hosts: https://developers.zarv.com/setup
- Índice das APIs: https://developers.zarv.com/api
- Índice da documentação em markdown: https://developers.zarv.com/llms.txt
- Documentação completa em um arquivo: https://developers.zarv.com/llms-full.txt

Os specs OpenAPI publicados são a fonte da verdade para rotas e schemas — use o spec da API que você escolher antes de escrever qualquer request.

Antes de escrever qualquer código, leia a página desta integração. Siga exatamente os nomes de campos, endpoints, callbacks e formatos que estiverem documentados — não invente parâmetros nem endpoints, e não deduza comportamento a partir de outras APIs que você conhece. Se algo de que você precisa não estiver na documentação, diga que não está em vez de supor.

Minha tarefa: [ex.: escolher a API certa e fazer a primeira chamada autenticada]

Iniciar lead​

POST
/api/v1/smartflow/leads

Cria um lead no fluxo informado e retorna o primeiro passo e a nextStepUrl a chamar. O campo externalId funciona como chave de idempotência: repetir a chamada com o mesmo valor retorna o lead já criado. Se prefill trouxer dados de identidade (name, nationalId, birthDate), é obrigatório enviar acceptedTerms: true; caso contrário a resposta é 400 com o código terms_required. Os campos utm e metadata são gravados no lead e devolvidos nas leituras de status e no webhook.

Authorizations​

Authentication v2

For more details, see Authentication v2

Type
HTTP (bearer)

Request Body​

application/json
JSON
{
  
"flowId": "string",
  
"externalId": "string",
  
"acceptedTerms": true,
  
"prefill": {
  
  
"name": "string",
  
  
"nationalId": "string",
  
  
"birthDate": "string",
  
  
"phone": "string",
  
  
"email": "string"
  
},
  
"utm": {
  
  
"additionalProperties": "string"
  
},
  
"metadata": {
  
  
"additionalProperties": "string"
  
}
}

Responses​

Lead criado (ou lead existente, quando externalId já foi usado).

application/json
JSON
{
  
"leadId": "lead_01HZX",
  
"status": "in_progress",
  
"step": "email",
  
"nextStep": "phone",
  
"nextStepUrl": "/api/v1/smartflow/leads/lead_01HZX/phone",
  
"progress": 40,
  
"finished": false
}

Playground​

Authorization
Body

Samples​

Powered by VitePress OpenAPI