Referência

Mudanças

Acréscimos entram na versão atual; o que quebra, só em versão nova (veja a política).

2026-10-01

Acréscimo (outubro de 2026): arquivos.

  • POST /v1/files, com o escopo files:write: o seu sistema manda o PDF (holerite, guia, nota) em base64 e a Torqyn entrega ao contato. O dono é o contact_external_id ou, sem ele, o que o nome do arquivo e o CPF/CNPJ do PDF apontam; o que não casa fica em "Sem dono" no painel. external_id repetido não duplica. Esta rota aceita corpo de até cerca de 14 MB (PDF de até 10 MB).

Acréscimo (outubro de 2026): datasets.

  • PUT, GET e DELETE /v1/datasets/{dataset}/records/{external_id}, com os escopos datasets:read e datasets:write: o seu sistema mantém, linha a linha, uma tabela de dados (criada no painel, com a fonte "API") que o assistente consulta e que vira público de comunicado. Coluna desconhecida é recusada; coluna sensível nunca sai.

Acréscimo (outubro de 2026): recompensas.

  • GET /v1/contacts/{external_id}/rewards e POST /v1/contacts/{external_id}/rewards/redeem, com os escopos rewards:read e rewards:write: o saldo de crédito (indicação e cashback) e o uso numa compra, conferindo a validade e a compra mínima.
  • Eventos de webhook referral.converted, reward.granted, reward.redeemed e reward.expired.

A primeira versão da API.

  • Chaves de teste e de produção, com escopos, IPs permitidos e validade; conta de teste com canal simulado e números de teste.
  • Contatos pelo id do seu sistema, com etiquetas; consentimentos com evidência, e o descadastro valendo acima de tudo.
  • Tipos de evento cadastrados no painel e POST /v1/events: a IA escreve com a janela aberta, o modelo aprovado sai com ela fechada.
  • Mensagens diretas: POST /v1/messages (modelo aprovado a qualquer hora, texto só com a janela aberta), GET /v1/messages/{id} com o status e GET /v1/templates por número.
  • Webhooks com eventos escolhidos, segredo whsec_, troca com 24 horas de sobreposição, evento de teste, histórico e reenvio; GET /v1/events.
  • Idempotência, erros com code estável, paginação por cursor e limites com os cabeçalhos RateLimit-*.