Primeiros passos com a API REST

#Antes de começar

• Crie um token com as permissões que a integração precisa: veja Criar um token de API.
• O endereço base aparece pronto para copiar no cartão API REST, em Base URL. Nos exemplos abaixo, troque https://app.metodox.com.br pelo endereço do seu ZapFlow.

12

1. 1Novo token
2. 2Documentação (Swagger)

#O básico

O token age com o acesso de quem o criou: se essa pessoa só vê os próprios leads ou algumas linhas, a API respeita o mesmo recorte.

#Exemplos

#Listar contatos

curl -H "Authorization: Bearer zf_seu_token" \
  "https://app.metodox.com.br/api/v1/contacts?limit=20&search=carolina"

A resposta traz data (os contatos) e pagination (page, limit, total, total_pages). Aceita também tag (nome da tag) e page. O limit vai até 100.

#Mandar uma mensagem de texto

Primeiro descubra o identificador da linha que vai enviar:

curl -H "Authorization: Bearer zf_seu_token" \
  "https://app.metodox.com.br/api/v1/instances"

Use o phone_number_id da linha escolhida como instance_id:

curl -X POST "https://app.metodox.com.br/api/v1/messages/text" \
  -H "Authorization: Bearer zf_seu_token" \
  -H "Content-Type: application/json" \
  -d '{
    "instance_id": "PHONE_NUMBER_ID_DA_LINHA",
    "to": "5511987650001",
    "content": "Oi, Carolina! Sua vaga na aula ao vivo está garantida."
  }'

#Aplicar uma tag a um contato

Liste as tags para pegar o id:

curl -H "Authorization: Bearer zf_seu_token" \
  "https://app.metodox.com.br/api/v1/tags"

Depois aplique pelo telefone do contato:

curl -X POST "https://app.metodox.com.br/api/v1/contacts/5511987650001/tags" \
  -H "Authorization: Bearer zf_seu_token" \
  -H "Content-Type: application/json" \
  -d '{ "tag_id": 12 }'

Aplicar uma tag pela API dispara os fluxos com o gatilho Tag Atribuída, como se a tag tivesse sido aplicada na tela.

#O que mais dá para fazer

A documentação lista os endpoints agrupados por assunto: contatos e campos, tags e ações, mensagens (texto, imagem, documento, áudio), Kanban (mover card, destacar, trocar de quadro), fluxos e versões, linhas, opt-out e mais. Cada endpoint mostra o corpo esperado e as respostas possíveis.

#Se algo der errado

#Perguntas frequentes