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/submitCustomField
- 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]

Enviar campo personalizado​

POST
/api/v1/smartflow/leads/{id}/custom/{fieldId}

Grava um único campo personalizado por chamada, com mescla por id (não substitui os demais). A resposta traz nextCustomField com o próximo campo pendente; o step permanece custom até que todos os campos obrigatórios estejam preenchidos e só então avança. Os campos disponíveis vêm de fields em getFlow.

Campos do tipo file são enviados como multipart/form-data com o arquivo na parte file (os demais tipos usam JSON { "value": ... }). O arquivo é validado (máx. 10MB e tipo MIME conforme os grupos do campo) e armazenado; a chave do objeto vira o valor do campo. Erros: file_required, file_too_large, file_type_not_allowed (400) e upload_failed (502).

Authorizations​

Authentication v2

For more details, see Authentication v2

Type
HTTP (bearer)

Parameters​

Path Parameters

id*

Identificador do lead (leadId).

Type
string
Required
fieldId*

Identificador do campo personalizado (por exemplo, f_k3n8p2q7).

Type
string
Required

Request Body​

JSON
{
  
"value": "string"
}

Responses​

Lead avançado; retorna o envelope padrão com o próximo passo.

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,
  
"nextCustomField": {
  
  
"id": "f_k3n8p2q7",
  
  
"type": "text",
  
  
"label": "Matrícula",
  
  
"required": true
  
}
}

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Powered by VitePress OpenAPI