Collection do Postman

Uma collection com todas as rotas desta referência, organizadas nas mesmas seções, com corpos de exemplo prontos para enviar e os ids passando de uma chamada para a outra sem copiar nada.

Baixar a collectionBaixar o ambiente

Importando

1. No Postman, Import → arraste os dois arquivos. Se preferir não baixar, Import → Link e cole https://docs.joinotify.com/postman/Joinotify.postman_collection.json.
2. Selecione o ambiente Joinotify — Produção no canto superior direito.
3. Preencha apiKey com o seu token sk_live_... — ele é gerado no painel depois de conectar um número. A variável é do tipo secret: o Postman a esconde na tela.
4. Rode Conta → Listar números de origem (GET /account/senders) primeiro. Ele guarda o phoneNumberId e o wabaId do seu primeiro número, que o espelho /v1 e várias rotas usam.

A autenticação é da collection inteira (Bearer Token com {{apiKey}}). As poucas rotas públicas — planos, troca de código de pareamento, webhook de gatilho de fluxo — já vêm com No Auth.

Insomnia

O Insomnia importa collections do Postman: Create → Import → escolha o arquivo da collection.

Variáveis

Variável	De onde vem
baseUrl	O ambiente. https://api.joinotify.com
apiKey	O ambiente. O seu token sk_live_...
phoneNumberId	GET /account/senders, na primeira vez que roda
wabaId	GET /account/senders, na primeira vez que roda
businessId	Você preenche — só as rotas de bases de clientes do espelho usam
contactId, broadcastId, audienceId, tagId…	Guardados sozinhos, veja abaixo
mediaContentType	O Content-Type dos uploads em bytes crus. Vem image/jpeg; troque para o tipo do seu arquivo

Ids que se preenchem sozinhos

Criar um recurso guarda o id dele: Criar contato preenche contactId, e em seguida Consultar um contato, Editar um contato e Registrar opt-in já apontam para ele. O mesmo vale para campanhas, públicos, tags, campos, endpoints de webhook e chaves.

Uma listagem também guarda o id do primeiro item — mas só quando a variável ainda está vazia, para não trocar o recurso com que você está trabalhando. Para apontar para outro, edite o valor em Variables na collection.

Deixe os ids fora do ambiente

Os ids ficam nas variáveis da collection. O Postman lê o ambiente antes dela, então uma variável com o mesmo nome no ambiente — mesmo vazia — esconde o id que acabou de ser guardado.

O que vem pronto

• Enviar mensagem aparece em quatro variações: texto, template, template agendado e mensagem de teste.
• Responder numa conversa da inbox vem como texto, template e nota interna.
• POST /messages, POST /contacts/sync e POST /site-events trazem o header Idempotency-Key desligado e preenchido com {{$guid}} — ligue para que uma repetição devolva a primeira resposta em vez de executar de novo.
• Os parâmetros de consulta opcionais (filtros, limit, offset) vêm listados e desligados, cada um com a descrição da referência.
• A descrição de cada requisição é a mesma desta referência.

Os corpos de exemplo usam números e nomes fictícios, e os de template pressupõem um template aprovado com esse nome — troque pelos seus antes de enviar.

Mantendo em dia

A collection acompanha a versão da referência, dita no fim da descrição dela. Quando a API ganhar rotas, baixe de novo e importe: o Postman reconhece a collection e oferece substituir a que você já tem. Suas variáveis de ambiente não são tocadas.

Prefere gerar a sua a partir da spec? O arquivo OpenAPI também importa no Postman.