{"openapi":"3.1.0","info":{"title":"API do SyncAtende","version":"1.0.0","description":"API de automação do SyncAtende. Documentação em texto: /api/docs. Uma chave dá acesso a toda a API: ler, criar, alterar e excluir (chaves antigas só de leitura continuam só de leitura, apenas GET). O x-scope de cada rota diz se ela só consulta (read) ou age (write). A empresa vem sempre da chave. Erros: { \"error\": \"motivo em português\" }. Idempotency-Key em todo POST."},"servers":[{"url":"https://app.syncatende.com.br/api/v1"}],"security":[{"bearerAuth":[]}],"tags":[{"name":"Atendimentos"},{"name":"Mensagens"},{"name":"Templates (Central de disparo)"},{"name":"Campanhas e listas (Central de disparo)"},{"name":"Descoberta de ids"},{"name":"Contatos"},{"name":"Webhooks"},{"name":"Kanban"},{"name":"Relatórios"},{"name":"Documentação"}],"paths":{"/tickets":{"get":{"tags":["Atendimentos"],"summary":"Lista atendimentos, do mais recente ao mais antigo","operationId":"getTickets","x-scope":"read","parameters":[{"name":"status","in":"query","required":false,"description":"waiting, active ou closed","schema":{"type":"string"}},{"name":"sectorId","in":"query","required":false,"description":"setor","schema":{"type":"string"}},{"name":"assignedUserId","in":"query","required":false,"description":"responsável","schema":{"type":"string"}},{"name":"tag","in":"query","required":false,"description":"etiqueta do atendimento","schema":{"type":"string"}},{"name":"phone","in":"query","required":false,"description":"número do cliente","schema":{"type":"string"}},{"name":"updatedSince","in":"query","required":false,"description":"ISO 8601","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"1 a 200, padrão 50","schema":{"type":"string"}},{"name":"offset","in":"query","required":false,"description":"quantos pular","schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"tickets":{"type":"array","items":{"$ref":"#/components/schemas/Ticket"}},"limit":{"type":"integer"},"offset":{"type":"integer"},"hasMore":{"type":"boolean"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/tickets/{id}":{"get":{"tags":["Atendimentos"],"summary":"Lê um atendimento","operationId":"getTicketsId","x-scope":"read","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"ticket":{"$ref":"#/components/schemas/Ticket"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/tickets/{id}/read":{"post":{"tags":["Atendimentos"],"summary":"Marca a última mensagem do cliente como lida (com typing, mostra digitando)","operationId":"postTicketsIdRead","x-scope":"write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","required":false,"description":"Repetir o mesmo pedido com a mesma chave devolve a resposta guardada em vez de executar de novo (até 200 caracteres)","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"typing":{"type":"boolean"}}}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"messageId":{"type":"string"},"typing":{"type":"boolean"},"ticket":{"$ref":"#/components/schemas/Ticket"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Chave antiga só de leitura, ou empresa suspensa ou bloqueada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/tickets/{id}/transfer":{"post":{"tags":["Atendimentos"],"summary":"Transfere para um setor (fila) ou para uma pessoa","operationId":"postTicketsIdTransfer","x-scope":"write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","required":false,"description":"Repetir o mesmo pedido com a mesma chave devolve a resposta guardada em vez de executar de novo (até 200 caracteres)","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"sectorId":{"type":"string"},"userId":{"type":"string"},"note":{"type":"string"}}}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"ticket":{"$ref":"#/components/schemas/Ticket"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Chave antiga só de leitura, ou empresa suspensa ou bloqueada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/tickets/{id}/close":{"post":{"tags":["Atendimentos"],"summary":"Conclui o atendimento","operationId":"postTicketsIdClose","x-scope":"write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","required":false,"description":"Repetir o mesmo pedido com a mesma chave devolve a resposta guardada em vez de executar de novo (até 200 caracteres)","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"note":{"type":"string"}}}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"ticket":{"$ref":"#/components/schemas/Ticket"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Chave antiga só de leitura, ou empresa suspensa ou bloqueada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/tickets/{id}/notes":{"get":{"tags":["Atendimentos"],"summary":"Lista as notas internas","operationId":"getTicketsIdNotes","x-scope":"read","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"notes":{"type":"array","items":{"$ref":"#/components/schemas/Note"}}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"tags":["Atendimentos"],"summary":"Cria uma nota interna (até 2000 caracteres)","operationId":"postTicketsIdNotes","x-scope":"write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","required":false,"description":"Repetir o mesmo pedido com a mesma chave devolve a resposta guardada em vez de executar de novo (até 200 caracteres)","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"text":{"type":"string"}},"required":["text"]}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"note":{"$ref":"#/components/schemas/Note"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Chave antiga só de leitura, ou empresa suspensa ou bloqueada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/tickets/{id}/history":{"get":{"tags":["Atendimentos"],"summary":"Linha do tempo do atendimento (assumiu, transferiu, concluiu, reiniciou)","operationId":"getTicketsIdHistory","x-scope":"read","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"events":{"type":"array","items":{"$ref":"#/components/schemas/HistoryEvent"}}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/tickets/{id}/restart":{"post":{"tags":["Atendimentos"],"summary":"Reinicia um atendimento concluído (409 se não estiver concluído, ou se o número já tem outro aberto)","operationId":"postTicketsIdRestart","x-scope":"write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","required":false,"description":"Repetir o mesmo pedido com a mesma chave devolve a resposta guardada em vez de executar de novo (até 200 caracteres)","schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"ticket":{"$ref":"#/components/schemas/Ticket"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Chave antiga só de leitura, ou empresa suspensa ou bloqueada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/tickets/{id}/tags":{"post":{"tags":["Atendimentos"],"summary":"Põe e tira etiquetas do atendimento","operationId":"postTicketsIdTags","x-scope":"write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","required":false,"description":"Repetir o mesmo pedido com a mesma chave devolve a resposta guardada em vez de executar de novo (até 200 caracteres)","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"add":{"type":"array","items":{"type":"string"}},"remove":{"type":"array","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"ticket":{"$ref":"#/components/schemas/Ticket"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Chave antiga só de leitura, ou empresa suspensa ou bloqueada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/tickets/{id}/messages":{"get":{"tags":["Mensagens"],"summary":"Lê as mensagens do atendimento","operationId":"getTicketsIdMessages","x-scope":"read","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"1 a 200, padrão 50","schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"ticket":{"$ref":"#/components/schemas/Ticket"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/Message"}}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"tags":["Mensagens"],"summary":"Envia texto, template, mídia, botões, lista, link, reação ou resposta citando (type: text, template, reaction, buttons, list, cta_url, image, audio, video, document, sticker). type template é o único que sai fora da janela de 24 horas","operationId":"postTicketsIdMessages","x-scope":"write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","required":false,"description":"Repetir o mesmo pedido com a mesma chave devolve a resposta guardada em vez de executar de novo (até 200 caracteres)","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string"},"text":{"type":"string"},"caption":{"type":"string"},"emoji":{"type":"string"},"messageId":{"type":"string"},"replyTo":{"type":"string"},"media":{"type":"object","properties":{"data":{"type":"string"},"url":{"type":"string"},"mime":{"type":"string"},"filename":{"type":"string"},"voice":{"type":"boolean"}}},"template":{"type":"object","properties":{"templateId":{"type":"string"},"name":{"type":"string"},"language":{"type":"string"},"params":{"type":"object","additionalProperties":{"type":"string"}},"header":{"type":"object","properties":{"id":{"type":"string"},"link":{"type":"string"},"data":{"type":"string"},"mime":{"type":"string"},"filename":{"type":"string"}}},"buttons":{"type":"array","items":{"type":"object","properties":{"index":{"type":"integer"},"text":{"type":"string"},"payload":{"type":"string"},"coupon":{"type":"string"}}}}}}}}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"$ref":"#/components/schemas/Message"},"ticket":{"$ref":"#/components/schemas/Ticket"},"template":{},"window":{"type":"object","properties":{"open":{"type":"boolean"},"lastInboundAt":{"type":["string","null"]},"closesAt":{"type":["string","null"]}}}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Chave antiga só de leitura, ou empresa suspensa ou bloqueada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/templates":{"get":{"tags":["Templates (Central de disparo)"],"summary":"Lista os templates da empresa com status ao vivo (aprovado, em análise, rejeitado com motivo, pausado). Só com a Central de disparo liberada pelo provedor (403 reason broadcast_off)","operationId":"getTemplates","x-scope":"read","parameters":[{"name":"status","in":"query","required":false,"description":"APPROVED, PENDING, REJECTED, PAUSED…","schema":{"type":"string"}},{"name":"category","in":"query","required":false,"description":"MARKETING ou UTILITY","schema":{"type":"string"}},{"name":"q","in":"query","required":false,"description":"título ou nome","schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"templates":{"type":"array","items":{"$ref":"#/components/schemas/Template"}},"totals":{"type":"object","additionalProperties":{"type":"integer"}},"count":{"type":"integer"},"limit":{"type":"integer"},"lastSyncedAt":{"type":["string","null"]},"syncError":{"type":["string","null"]}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"tags":["Templates (Central de disparo)"],"summary":"Cria o template e envia à Meta para análise (parâmetros nomeados, {{nome}}). 422 com a lista errors quando o texto quebra uma regra antes de ir à Meta. Marketing leva o botão Parar de receber por padrão. Exemplo de cabeçalho de mídia em sample.data (base64)","operationId":"postTemplates","x-scope":"write","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"description":"Repetir o mesmo pedido com a mesma chave devolve a resposta guardada em vez de executar de novo (até 200 caracteres)","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateInput"}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"status":{"type":"string"},"warnings":{"type":"array","items":{}}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Chave antiga só de leitura, ou empresa suspensa ou bloqueada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/templates/{id}":{"get":{"tags":["Templates (Central de disparo)"],"summary":"Lê um template, com motivo de rejeição, histórico de mudanças e o veredito do auditor de categoria","operationId":"getTemplatesId","x-scope":"read","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"template":{"$ref":"#/components/schemas/Template"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"tags":["Templates (Central de disparo)"],"summary":"Exclui o template na Meta (todos os idiomas do nome). Template aprovado excluído não pode ser recriado com o mesmo nome por 30 dias","operationId":"deleteTemplatesId","x-scope":"write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"id":{"type":"string"},"note":{"type":["string","null"]}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Chave antiga só de leitura, ou empresa suspensa ou bloqueada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/campaigns":{"get":{"tags":["Campanhas e listas (Central de disparo)"],"summary":"Lista as campanhas, da mais recente para a mais antiga, com o funil de cada uma e os totais por situação","operationId":"getCampaigns","x-scope":"read","parameters":[{"name":"status","in":"query","required":false,"description":"scheduled, running, paused, completed ou canceled","schema":{"type":"string"}},{"name":"q","in":"query","required":false,"description":"nome da campanha","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"1 a 200, padrão 50","schema":{"type":"string"}},{"name":"offset","in":"query","required":false,"description":"quantos pular","schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"campaigns":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"status":{"type":"string"},"statusLabel":{"type":"string"},"template":{"type":"object"},"audience":{"type":"array","items":{"type":"string"}},"progress":{"$ref":"#/components/schemas/Funnel"},"recipients":{"type":"integer"},"scheduledAt":{"type":["string","null"]},"startedAt":{"type":["string","null"]},"finishedAt":{"type":["string","null"]},"createdAt":{"type":"string"}}}},"total":{"type":"integer"},"totals":{"type":"object","additionalProperties":{"type":"integer"}},"limit":{"type":"integer"},"offset":{"type":"integer"},"hasMore":{"type":"boolean"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"tags":["Campanhas e listas (Central de disparo)"],"summary":"Sem launch true, devolve só a revisão (público, exclusões por motivo, custo máximo, limite do dia, ondas e janela) e não grava nada. Com launch true, congela o público e dispara ou agenda (201; o mesmo Idempotency-Key ou requestId devolve a mesma campanha com 200). Marketing exige optIn.declaration true. Teto por chave: apiCampaignsPerHour (padrão 10 por hora, 429)","operationId":"postCampaigns","x-scope":"write","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"description":"Repetir o mesmo pedido com a mesma chave devolve a resposta guardada em vez de executar de novo (até 200 caracteres)","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignInput"}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"campaign":{"$ref":"#/components/schemas/Campaign"},"duplicate":{"type":"boolean"},"launched":{"type":"boolean"},"preview":{"type":"object"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Chave antiga só de leitura, ou empresa suspensa ou bloqueada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/campaigns/{id}":{"get":{"tags":["Campanhas e listas (Central de disparo)"],"summary":"Lê a campanha com as métricas: funil, taxas, falhas por motivo, respostas e cliques por botão, descadastros, custo estimado e apurado, entrega ao longo do tempo e ondas diárias","operationId":"getCampaignsId","x-scope":"read","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"campaign":{"$ref":"#/components/schemas/Campaign"},"metrics":{"type":"object"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/campaigns/{id}/messages":{"get":{"tags":["Campanhas e listas (Central de disparo)"],"summary":"Destinatários com a situação de cada um (queued, sending, sent, delivered, read, failed, skipped, canceled, unknown ou replied), o código da Meta e o motivo em português","operationId":"getCampaignsIdMessages","x-scope":"read","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"state","in":"query","required":false,"description":"situação, ou replied para quem respondeu","schema":{"type":"string"}},{"name":"q","in":"query","required":false,"description":"nome ou telefone","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"1 a 200, padrão 50","schema":{"type":"string"}},{"name":"offset","in":"query","required":false,"description":"quantos pular","schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"messages":{"type":"array","items":{"$ref":"#/components/schemas/CampaignMessage"}},"total":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"hasMore":{"type":"boolean"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/campaigns/{id}/report.xlsx":{"get":{"tags":["Campanhas e listas (Central de disparo)"],"summary":"O relatório da campanha em planilha XLSX (resumo, destinatários com o ref do rastreio, falhas por motivo, respostas, entrega no tempo e ondas)","operationId":"getCampaignsIdReportXlsx","x-scope":"read","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/campaigns/{id}/pause":{"post":{"tags":["Campanhas e listas (Central de disparo)"],"summary":"Pausa a campanha agendada ou em envio (409 nos outros estados)","operationId":"postCampaignsIdPause","x-scope":"write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","required":false,"description":"Repetir o mesmo pedido com a mesma chave devolve a resposta guardada em vez de executar de novo (até 200 caracteres)","schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"campaign":{"$ref":"#/components/schemas/Campaign"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Chave antiga só de leitura, ou empresa suspensa ou bloqueada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/campaigns/{id}/resume":{"post":{"tags":["Campanhas e listas (Central de disparo)"],"summary":"Retoma a campanha pausada (409 se o número está desconectado ou o template deixou de estar aprovado)","operationId":"postCampaignsIdResume","x-scope":"write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","required":false,"description":"Repetir o mesmo pedido com a mesma chave devolve a resposta guardada em vez de executar de novo (até 200 caracteres)","schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"campaign":{"$ref":"#/components/schemas/Campaign"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Chave antiga só de leitura, ou empresa suspensa ou bloqueada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/campaigns/{id}/cancel":{"post":{"tags":["Campanhas e listas (Central de disparo)"],"summary":"Cancela a campanha: o que estava na fila não sai; o que já saiu não volta","operationId":"postCampaignsIdCancel","x-scope":"write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","required":false,"description":"Repetir o mesmo pedido com a mesma chave devolve a resposta guardada em vez de executar de novo (até 200 caracteres)","schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"campaign":{"$ref":"#/components/schemas/Campaign"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Chave antiga só de leitura, ou empresa suspensa ou bloqueada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/broadcast-lists":{"get":{"tags":["Campanhas e listas (Central de disparo)"],"summary":"Aposentada (410 Gone): as listas importadas não existem mais. A planilha vai dentro da campanha, em audience.sheet de POST /campaigns, e vale só para ela","operationId":"getBroadcastLists","x-scope":"read","responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"reason":{"type":"string"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"tags":["Campanhas e listas (Central de disparo)"],"summary":"Aposentada (410 Gone): as listas importadas não existem mais. A planilha vai dentro da campanha, em audience.sheet de POST /campaigns, e vale só para ela","operationId":"postBroadcastLists","x-scope":"write","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"description":"Repetir o mesmo pedido com a mesma chave devolve a resposta guardada em vez de executar de novo (até 200 caracteres)","schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"reason":{"type":"string"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Chave antiga só de leitura, ou empresa suspensa ou bloqueada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/broadcast-lists/{id}":{"get":{"tags":["Campanhas e listas (Central de disparo)"],"summary":"Aposentada (410 Gone): as listas importadas não existem mais. A planilha vai dentro da campanha, em audience.sheet de POST /campaigns, e vale só para ela","operationId":"getBroadcastListsId","x-scope":"read","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"reason":{"type":"string"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"tags":["Campanhas e listas (Central de disparo)"],"summary":"Aposentada (410 Gone): as listas importadas não existem mais. A planilha vai dentro da campanha, em audience.sheet de POST /campaigns, e vale só para ela","operationId":"deleteBroadcastListsId","x-scope":"write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"reason":{"type":"string"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Chave antiga só de leitura, ou empresa suspensa ou bloqueada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/suppressions":{"get":{"tags":["Campanhas e listas (Central de disparo)"],"summary":"A lista de saída: quem pediu para não receber marketing (ou nada), com o motivo. O número não fica guardado (só um hash e os 4 últimos dígitos): a resposta traz last4","operationId":"getSuppressions","x-scope":"read","parameters":[{"name":"q","in":"query","required":false,"description":"os 4 últimos dígitos","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"1 a 200, padrão 50","schema":{"type":"string"}},{"name":"offset","in":"query","required":false,"description":"quantos pular","schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"suppressions":{"type":"array","items":{"$ref":"#/components/schemas/Suppression"}},"total":{"type":"integer"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"tags":["Campanhas e listas (Central de disparo)"],"summary":"Põe telefones na lista de saída (phone ou até 500 em phones; scope marketing, padrão, ou all)","operationId":"postSuppressions","x-scope":"write","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"description":"Repetir o mesmo pedido com a mesma chave devolve a resposta guardada em vez de executar de novo (até 200 caracteres)","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"phone":{"type":"string"},"phones":{"type":"array","items":{"type":"string"}},"scope":{"enum":["marketing","all"]}}}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"added":{"type":"integer"},"invalid":{"type":"array","items":{"type":"string"}}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Chave antiga só de leitura, ou empresa suspensa ou bloqueada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/suppressions/{phone}":{"delete":{"tags":["Campanhas e listas (Central de disparo)"],"summary":"Tira o telefone da lista de saída (registrado na auditoria): o servidor calcula o hash do número informado e remove. scope opcional na query","operationId":"deleteSuppressionsPhone","x-scope":"write","parameters":[{"name":"phone","in":"path","required":true,"schema":{"type":"string"}},{"name":"scope","in":"query","required":false,"description":"marketing ou all; sem ele, tira dos dois","schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"removed":{"type":"integer"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Chave antiga só de leitura, ou empresa suspensa ou bloqueada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/messages/{id}":{"get":{"tags":["Mensagens"],"summary":"Lê uma mensagem pelo id","operationId":"getMessagesId","x-scope":"read","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"$ref":"#/components/schemas/Message"},"ticketId":{"type":["string","null"]}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/messages/{id}/media":{"get":{"tags":["Mensagens"],"summary":"Baixa o arquivo da mensagem","operationId":"getMessagesIdMedia","x-scope":"read","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/media/{companyId}/{messageId}":{"get":{"tags":["Mensagens"],"summary":"Download pelo downloadUrl assinado do webhook (sem chave; vale 7 dias)","operationId":"getMediaCompanyIdMessageId","x-scope":"public","security":[],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string"}},{"name":"messageId","in":"path","required":true,"schema":{"type":"string"}},{"name":"e","in":"query","required":false,"description":"validade da assinatura","schema":{"type":"string"}},{"name":"s","in":"query","required":false,"description":"assinatura","schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/sectors":{"get":{"tags":["Descoberta de ids"],"summary":"Setores ativos, com o setor padrão","operationId":"getSectors","x-scope":"read","responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"sectors":{"type":"array","items":{"$ref":"#/components/schemas/Sector"}},"defaultSectorId":{"type":["string","null"]}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"tags":["Descoberta de ids"],"summary":"Cria um setor (2 a 40 caracteres). Se existir um arquivado com o mesmo nome, ele volta (200, restored: true)","operationId":"postSectors","x-scope":"write","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"description":"Repetir o mesmo pedido com a mesma chave devolve a resposta guardada em vez de executar de novo (até 200 caracteres)","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"sector":{"$ref":"#/components/schemas/Sector"},"restored":{"type":"boolean"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Chave antiga só de leitura, ou empresa suspensa ou bloqueada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/sectors/{id}":{"patch":{"tags":["Descoberta de ids"],"summary":"Renomeia (name), arquiva ou reativa (active) e define o padrão (default: true). Arquivar recusa (409) com contas ou atendimentos abertos no setor, o último setor ativo e o setor padrão","operationId":"patchSectorsId","x-scope":"write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"active":{"type":"boolean"},"default":{"type":"boolean"}}}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"sector":{"$ref":"#/components/schemas/Sector"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Chave antiga só de leitura, ou empresa suspensa ou bloqueada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/agents":{"get":{"tags":["Descoberta de ids"],"summary":"Pessoas ativas da equipe (sem dados de acesso)","operationId":"getAgents","x-scope":"read","responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"agents":{"type":"array","items":{"$ref":"#/components/schemas/Agent"}}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/tags":{"get":{"tags":["Descoberta de ids"],"summary":"Etiquetas da empresa: dos atendimentos e do catálogo dos contatos (com cor)","operationId":"getTags","x-scope":"read","responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"object","properties":{"tag":{"type":"string"},"tickets":{"type":"integer"}}}},"contactTags":{"type":"array","items":{"$ref":"#/components/schemas/ContactTag"}}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/contact-tags":{"get":{"tags":["Descoberta de ids"],"summary":"Catálogo de etiquetas dos contatos (nome, cor e quantos contatos usam)","operationId":"getContactTags","x-scope":"read","responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"tags":{"type":"array","items":{"$ref":"#/components/schemas/ContactTag"}}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"tags":["Descoberta de ids"],"summary":"Cria a etiqueta no catálogo (até 200; cor #rrggbb opcional; se já existe, só muda a cor)","operationId":"postContactTags","x-scope":"write","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"description":"Repetir o mesmo pedido com a mesma chave devolve a resposta guardada em vez de executar de novo (até 200 caracteres)","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"color":{"type":["string","null"]}},"required":["name"]}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"tags":{"type":"array","items":{"$ref":"#/components/schemas/ContactTag"}},"tag":{"type":"string"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Chave antiga só de leitura, ou empresa suspensa ou bloqueada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/contact-tags/{tag}":{"patch":{"tags":["Descoberta de ids"],"summary":"Renomeia (em todos os contatos) e/ou muda a cor","operationId":"patchContactTagsTag","x-scope":"write","parameters":[{"name":"tag","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"color":{"type":["string","null"]}}}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"tags":{"type":"array","items":{"$ref":"#/components/schemas/ContactTag"}}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Chave antiga só de leitura, ou empresa suspensa ou bloqueada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"tags":["Descoberta de ids"],"summary":"Exclui a etiqueta de todos os contatos","operationId":"deleteContactTagsTag","x-scope":"write","parameters":[{"name":"tag","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"tags":{"type":"array","items":{"$ref":"#/components/schemas/ContactTag"}}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Chave antiga só de leitura, ou empresa suspensa ou bloqueada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/contact-fields":{"get":{"tags":["Descoberta de ids"],"summary":"Definições dos campos personalizados do contato (precisa estar liberado para a empresa)","operationId":"getContactFields","x-scope":"read","responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/ContactField"}}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"tags":["Descoberta de ids"],"summary":"Cria a definição de um campo (até 5; a chave vem do nome se não for enviada e não muda depois)","operationId":"postContactFields","x-scope":"write","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"description":"Repetir o mesmo pedido com a mesma chave devolve a resposta guardada em vez de executar de novo (até 200 caracteres)","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"key":{"type":"string"}},"required":["name"]}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/ContactField"}},"field":{"$ref":"#/components/schemas/ContactField"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Chave antiga só de leitura, ou empresa suspensa ou bloqueada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/contact-fields/{key}":{"patch":{"tags":["Descoberta de ids"],"summary":"Renomeia o campo (a chave não muda)","operationId":"patchContactFieldsKey","x-scope":"write","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/ContactField"}}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Chave antiga só de leitura, ou empresa suspensa ou bloqueada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"tags":["Descoberta de ids"],"summary":"Exclui o campo e os valores dele em todos os contatos","operationId":"deleteContactFieldsKey","x-scope":"write","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/ContactField"}},"deleted":{"type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"contacts":{"type":"integer"}}}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Chave antiga só de leitura, ou empresa suspensa ou bloqueada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/contacts":{"get":{"tags":["Contatos"],"summary":"Busca contatos por phone, q, tag, ou por field e value","operationId":"getContacts","x-scope":"read","parameters":[{"name":"phone","in":"query","required":false,"description":"número","schema":{"type":"string"}},{"name":"q","in":"query","required":false,"description":"nome, e-mail ou externalId","schema":{"type":"string"}},{"name":"tag","in":"query","required":false,"description":"etiqueta do contato","schema":{"type":"string"}},{"name":"field","in":"query","required":false,"description":"chave de um campo do contato","schema":{"type":"string"}},{"name":"value","in":"query","required":false,"description":"valor do campo","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"1 a 200, padrão 50","schema":{"type":"string"}},{"name":"offset","in":"query","required":false,"description":"quantos pular","schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"contacts":{"type":"array","items":{"$ref":"#/components/schemas/Contact"}},"limit":{"type":"integer"},"offset":{"type":"integer"},"hasMore":{"type":"boolean"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"tags":["Contatos"],"summary":"Cria o contato (201) ou atualiza se o número já existe (200)","operationId":"postContacts","x-scope":"write","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"description":"Repetir o mesmo pedido com a mesma chave devolve a resposta guardada em vez de executar de novo (até 200 caracteres)","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"phone":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"externalId":{"type":"string"}},"required":["phone"]}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"contact":{"$ref":"#/components/schemas/Contact"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Chave antiga só de leitura, ou empresa suspensa ou bloqueada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/contacts/{waId}":{"get":{"tags":["Contatos"],"summary":"O contato e os atendimentos dele","operationId":"getContactsWaId","x-scope":"read","parameters":[{"name":"waId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"contact":{"$ref":"#/components/schemas/Contact"},"tickets":{"type":"array","items":{"$ref":"#/components/schemas/Ticket"}}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"patch":{"tags":["Contatos"],"summary":"Muda name, email e externalId (null apaga). O name é do contato: vale em todos os atendimentos do número e o WhatsApp não o sobrescreve; null volta ao nome do perfil. Funciona também para número que só tem atendimento (cria o contato)","operationId":"patchContactsWaId","x-scope":"write","parameters":[{"name":"waId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":["string","null"]},"email":{"type":["string","null"]},"externalId":{"type":["string","null"]}}}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"contact":{"$ref":"#/components/schemas/Contact"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Chave antiga só de leitura, ou empresa suspensa ou bloqueada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/contacts/{waId}/tags":{"post":{"tags":["Contatos"],"summary":"Põe e tira etiquetas do contato","operationId":"postContactsWaIdTags","x-scope":"write","parameters":[{"name":"waId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","required":false,"description":"Repetir o mesmo pedido com a mesma chave devolve a resposta guardada em vez de executar de novo (até 200 caracteres)","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"add":{"type":"array","items":{"type":"string"}},"remove":{"type":"array","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"contact":{"$ref":"#/components/schemas/Contact"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Chave antiga só de leitura, ou empresa suspensa ou bloqueada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/contacts/{waId}/notes":{"get":{"tags":["Contatos"],"summary":"Anotações do contato (as de todos os atendimentos do número)","operationId":"getContactsWaIdNotes","x-scope":"read","parameters":[{"name":"waId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"phone":{"type":"string"},"notes":{"type":"array","items":{"$ref":"#/components/schemas/Note"}}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"tags":["Contatos"],"summary":"Cria uma anotação (até 2000 caracteres) no atendimento mais recente do número; 404 se o número nunca teve atendimento","operationId":"postContactsWaIdNotes","x-scope":"write","parameters":[{"name":"waId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","required":false,"description":"Repetir o mesmo pedido com a mesma chave devolve a resposta guardada em vez de executar de novo (até 200 caracteres)","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"text":{"type":"string"}},"required":["text"]}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"phone":{"type":"string"},"notes":{"type":"array","items":{"$ref":"#/components/schemas/Note"}},"note":{"$ref":"#/components/schemas/Note"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Chave antiga só de leitura, ou empresa suspensa ou bloqueada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/contacts/{waId}/fields":{"get":{"tags":["Contatos"],"summary":"Valores dos campos personalizados do contato, por chave","operationId":"getContactsWaIdFields","x-scope":"read","parameters":[{"name":"waId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"phone":{"type":"string"},"fields":{"type":"object","additionalProperties":{"type":["string","null"]}}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"patch":{"tags":["Contatos"],"summary":"Grava só as chaves enviadas (null limpa)","operationId":"patchContactsWaIdFields","x-scope":"write","parameters":[{"name":"waId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"fields":{"type":"object","additionalProperties":{"type":["string","null"]}}},"required":["fields"]}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"phone":{"type":"string"},"fields":{"type":"object","additionalProperties":{"type":["string","null"]}}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Chave antiga só de leitura, ou empresa suspensa ou bloqueada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"tags":["Contatos"],"summary":"Limpa todos os campos do contato","operationId":"deleteContactsWaIdFields","x-scope":"write","parameters":[{"name":"waId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"phone":{"type":"string"},"fields":{"type":"object","additionalProperties":{"type":["string","null"]}}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Chave antiga só de leitura, ou empresa suspensa ou bloqueada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/webhooks":{"get":{"tags":["Webhooks"],"summary":"Lista os webhooks de saída da empresa (nome, url, eventos, ativo e última entrega; nunca o segredo)","operationId":"getWebhooks","x-scope":"read","responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"webhooks":{"type":"array","items":{"$ref":"#/components/schemas/WebhookItem"}},"limit":{"type":"integer"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"tags":["Webhooks"],"summary":"Cria um webhook (url obrigatória; name e events opcionais, padrão todos os eventos). Devolve o segredo uma vez. 409 ao chegar em 20","operationId":"postWebhooks","x-scope":"write","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"description":"Repetir o mesmo pedido com a mesma chave devolve a resposta guardada em vez de executar de novo (até 200 caracteres)","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"url":{"type":"string"},"events":{"type":"array","items":{"type":"string"}}},"required":["url"]}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"webhook":{"$ref":"#/components/schemas/WebhookItem"},"secret":{"type":"string"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Chave antiga só de leitura, ou empresa suspensa ou bloqueada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/webhooks/{id}":{"get":{"tags":["Webhooks"],"summary":"Lê um webhook","operationId":"getWebhooksId","x-scope":"read","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"webhook":{"$ref":"#/components/schemas/WebhookItem"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"patch":{"tags":["Webhooks"],"summary":"Muda só o que for enviado: name, url, events ou active (false pausa). Não troca o segredo","operationId":"patchWebhooksId","x-scope":"write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"url":{"type":"string"},"events":{"type":"array","items":{"type":"string"}},"active":{"type":"boolean"}}}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"webhook":{"$ref":"#/components/schemas/WebhookItem"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Chave antiga só de leitura, ou empresa suspensa ou bloqueada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"tags":["Webhooks"],"summary":"Exclui o webhook; o segredo dele deixa de valer","operationId":"deleteWebhooksId","x-scope":"write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"deleted":{"type":"boolean"},"id":{"type":"string"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Chave antiga só de leitura, ou empresa suspensa ou bloqueada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/webhooks/{id}/test":{"post":{"tags":["Webhooks"],"summary":"Envia um aviso de teste (ping) para este webhook, também pausado","operationId":"postWebhooksIdTest","x-scope":"write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","required":false,"description":"Repetir o mesmo pedido com a mesma chave devolve a resposta guardada em vez de executar de novo (até 200 caracteres)","schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"delivered":{"type":"boolean"},"status":{"type":["integer","null"]},"event":{"type":"string"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Chave antiga só de leitura, ou empresa suspensa ou bloqueada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/webhooks/{id}/secret":{"post":{"tags":["Webhooks"],"summary":"Gera um segredo novo (devolvido uma vez); o anterior para de valer na hora","operationId":"postWebhooksIdSecret","x-scope":"write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","required":false,"description":"Repetir o mesmo pedido com a mesma chave devolve a resposta guardada em vez de executar de novo (até 200 caracteres)","schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"webhook":{"$ref":"#/components/schemas/WebhookItem"},"secret":{"type":"string"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Chave antiga só de leitura, ou empresa suspensa ou bloqueada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/webhook":{"get":{"tags":["Webhooks"],"summary":"Legado: consulta o primeiro webhook de saída. Prefira GET /webhooks","operationId":"getWebhook","x-scope":"read","responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"webhook":{"oneOf":[{"$ref":"#/components/schemas/Webhook"},{"type":"null"}]}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"put":{"tags":["Webhooks"],"summary":"Legado: define a url do primeiro webhook (devolve o segredo uma vez; cria se não existir) e/ou os events","operationId":"putWebhook","x-scope":"write","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"events":{"type":"array","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"webhook":{"$ref":"#/components/schemas/Webhook"},"secret":{"type":"string"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Chave antiga só de leitura, ou empresa suspensa ou bloqueada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"tags":["Webhooks"],"summary":"Legado: exclui o primeiro webhook","operationId":"deleteWebhook","x-scope":"write","responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"webhook":{"type":"null"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Chave antiga só de leitura, ou empresa suspensa ou bloqueada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/webhook/test":{"post":{"tags":["Webhooks"],"summary":"Legado: envia um aviso de teste para o primeiro webhook","operationId":"postWebhookTest","x-scope":"write","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"description":"Repetir o mesmo pedido com a mesma chave devolve a resposta guardada em vez de executar de novo (até 200 caracteres)","schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"delivered":{"type":"boolean"},"status":{"type":["integer","null"]},"event":{"type":"string"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Chave antiga só de leitura, ou empresa suspensa ou bloqueada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/kanban":{"get":{"tags":["Kanban"],"summary":"Configuração do Kanban: ligado, setor, fase de encerramento, se o card nasce sozinho (autoCreate), de quais canais (autoCreateChannels: all, whatsapp ou instagram) e fases com ids","operationId":"getKanban","x-scope":"read","responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"kanban":{"type":"object","properties":{"enabled":{"type":"boolean"},"sector":{"type":["object","null"]},"onCloseStageId":{"type":["string","null"]},"autoCreate":{"type":"boolean"},"autoCreateChannels":{"type":"string"},"stages":{"type":"array","items":{"$ref":"#/components/schemas/Stage"}}}}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/kanban/stages":{"get":{"tags":["Kanban"],"summary":"Só as fases (ids, nomes, cores, ordem)","operationId":"getKanbanStages","x-scope":"read","responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"stages":{"type":"array","items":{"$ref":"#/components/schemas/Stage"}}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/kanban/fields":{"get":{"tags":["Kanban"],"summary":"Definições dos campos próprios dos cards","operationId":"getKanbanFields","x-scope":"read","responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/KanbanField"}},"limit":{"type":"integer"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"put":{"tags":["Kanban"],"summary":"Define a lista inteira dos campos dos cards (até 5)","operationId":"putKanbanFields","x-scope":"write","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"key":{"type":"string"},"name":{"type":"string"}}}}},"required":["fields"]}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/KanbanField"}},"limit":{"type":"integer"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Chave antiga só de leitura, ou empresa suspensa ou bloqueada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/kanban/cards":{"get":{"tags":["Kanban"],"summary":"Lista cards com filtros","operationId":"getKanbanCards","x-scope":"read","parameters":[{"name":"stageId","in":"query","required":false,"description":"fase","schema":{"type":"string"}},{"name":"ownerId","in":"query","required":false,"description":"responsável","schema":{"type":"string"}},{"name":"ticketId","in":"query","required":false,"description":"atendimento","schema":{"type":"string"}},{"name":"phone","in":"query","required":false,"description":"número","schema":{"type":"string"}},{"name":"tag","in":"query","required":false,"description":"etiqueta do card","schema":{"type":"string"}},{"name":"q","in":"query","required":false,"description":"nome ou telefone","schema":{"type":"string"}},{"name":"updatedSince","in":"query","required":false,"description":"ISO 8601","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"1 a 200, padrão 50","schema":{"type":"string"}},{"name":"offset","in":"query","required":false,"description":"quantos pular","schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"cards":{"type":"array","items":{"$ref":"#/components/schemas/KanbanCard"}},"limit":{"type":"integer"},"offset":{"type":"integer"},"hasMore":{"type":"boolean"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"tags":["Kanban"],"summary":"Cria o card do atendimento (idempotente: um por atendimento), com dados opcionais","operationId":"postKanbanCards","x-scope":"write","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"description":"Repetir o mesmo pedido com a mesma chave devolve a resposta guardada em vez de executar de novo (até 200 caracteres)","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ticketId":{"type":"string"},"stageId":{"type":"string"},"ownerUserId":{"type":["string","null"]},"valueCents":{"type":["integer","null"]},"dueDate":{"type":["string","null"]},"note":{"type":["string","null"]},"tags":{"type":"array","items":{"type":"string"}},"fields":{"type":"object","additionalProperties":{"type":["string","null"]}}},"required":["ticketId"]}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"card":{"$ref":"#/components/schemas/KanbanCard"},"created":{"type":"boolean"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Chave antiga só de leitura, ou empresa suspensa ou bloqueada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/kanban/cards/bulk-move":{"post":{"tags":["Kanban"],"summary":"Move até 500 cards para uma fase (tudo ou nada)","operationId":"postKanbanCardsBulkMove","x-scope":"write","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"description":"Repetir o mesmo pedido com a mesma chave devolve a resposta guardada em vez de executar de novo (até 200 caracteres)","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string"}},"stageId":{"type":"string"}},"required":["ids","stageId"]}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"moved":{"type":"integer"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Chave antiga só de leitura, ou empresa suspensa ou bloqueada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/kanban/cards/bulk-delete":{"post":{"tags":["Kanban"],"summary":"Exclui até 500 cards (tudo ou nada); o atendimento não é afetado","operationId":"postKanbanCardsBulkDelete","x-scope":"write","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"description":"Repetir o mesmo pedido com a mesma chave devolve a resposta guardada em vez de executar de novo (até 200 caracteres)","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string"}}},"required":["ids"]}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"deleted":{"type":"integer"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Chave antiga só de leitura, ou empresa suspensa ou bloqueada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/kanban/cards/{id}":{"get":{"tags":["Kanban"],"summary":"Lê um card","operationId":"getKanbanCardsId","x-scope":"read","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"card":{"$ref":"#/components/schemas/KanbanCard"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"patch":{"tags":["Kanban"],"summary":"Muda só o que for enviado; com version, 409 se outra pessoa mudou antes","operationId":"patchKanbanCardsId","x-scope":"write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardPatch"}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"card":{"$ref":"#/components/schemas/KanbanCard"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Chave antiga só de leitura, ou empresa suspensa ou bloqueada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"tags":["Kanban"],"summary":"Exclui o card (o atendimento continua)","operationId":"deleteKanbanCardsId","x-scope":"write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"deleted":{"type":"boolean"},"id":{"type":"string"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Chave antiga só de leitura, ou empresa suspensa ou bloqueada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/kanban/cards/{id}/move":{"post":{"tags":["Kanban"],"summary":"Move o card para uma fase","operationId":"postKanbanCardsIdMove","x-scope":"write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","required":false,"description":"Repetir o mesmo pedido com a mesma chave devolve a resposta guardada em vez de executar de novo (até 200 caracteres)","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"stageId":{"type":"string"}},"required":["stageId"]}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"card":{"$ref":"#/components/schemas/KanbanCard"}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Chave antiga só de leitura, ou empresa suspensa ou bloqueada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/reports/summary":{"get":{"tags":["Relatórios"],"summary":"Totais do período, por dia, por setor, por atendente (só pessoas), automação, série do gráfico e fluxos","operationId":"getReportsSummary","x-scope":"read","parameters":[{"name":"period","in":"query","required":false,"description":"today, yesterday, 7d, month, 3m ou 6m (padrão 7d)","schema":{"type":"string"}},{"name":"from","in":"query","required":false,"description":"AAAA-MM-DD (com to, no lugar de period; até 180 dias)","schema":{"type":"string"}},{"name":"to","in":"query","required":false,"description":"AAAA-MM-DD","schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"period":{},"totals":{},"byDay":{"type":"array","items":{}},"bySector":{"type":"array","items":{}},"flows":{"type":"array","items":{}},"agents":{"type":"array","items":{}},"automation":{},"series":{},"now":{},"busiestDay":{},"topSector":{},"topAgent":{}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/reports/contacts":{"get":{"tags":["Relatórios"],"summary":"Atendimentos iniciados no período (um item por atendimento; a mesma pessoa pode repetir). A resposta traz filters com a contagem de cada opção","operationId":"getReportsContacts","x-scope":"read","parameters":[{"name":"period","in":"query","required":false,"description":"today, yesterday, 7d, month, 3m ou 6m (padrão 7d)","schema":{"type":"string"}},{"name":"from","in":"query","required":false,"description":"AAAA-MM-DD (com to, no lugar de period; até 180 dias)","schema":{"type":"string"}},{"name":"to","in":"query","required":false,"description":"AAAA-MM-DD","schema":{"type":"string"}},{"name":"q","in":"query","required":false,"description":"nome ou telefone","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"a partir de 1","schema":{"type":"string"}},{"name":"pageSize","in":"query","required":false,"description":"1 a 200, padrão 50","schema":{"type":"string"}},{"name":"status","in":"query","required":false,"description":"waiting, active, closed ou open (aguardando e em curso)","schema":{"type":"string"}},{"name":"sector","in":"query","required":false,"description":"id do setor ou none (sem setor)","schema":{"type":"string"}},{"name":"agent","in":"query","required":false,"description":"id da pessoa ou automation","schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"integer"},"page":{"type":"integer"},"pageSize":{"type":"integer"},"items":{"type":"array","items":{}},"filters":{}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/reports/people":{"get":{"tags":["Relatórios"],"summary":"Contatos únicos do período, agrupados pelo telefone, com a quantidade de atendimentos de cada um. Situação, setor e atendente são os do último atendimento","operationId":"getReportsPeople","x-scope":"read","parameters":[{"name":"period","in":"query","required":false,"description":"today, yesterday, 7d, month, 3m ou 6m (padrão 7d)","schema":{"type":"string"}},{"name":"from","in":"query","required":false,"description":"AAAA-MM-DD (com to, no lugar de period; até 180 dias)","schema":{"type":"string"}},{"name":"to","in":"query","required":false,"description":"AAAA-MM-DD","schema":{"type":"string"}},{"name":"q","in":"query","required":false,"description":"nome ou telefone","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"a partir de 1","schema":{"type":"string"}},{"name":"pageSize","in":"query","required":false,"description":"1 a 200, padrão 50","schema":{"type":"string"}},{"name":"status","in":"query","required":false,"description":"waiting, active, closed ou open (aguardando e em curso)","schema":{"type":"string"}},{"name":"sector","in":"query","required":false,"description":"id do setor ou none (sem setor)","schema":{"type":"string"}},{"name":"agent","in":"query","required":false,"description":"id da pessoa ou automation","schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"integer"},"page":{"type":"integer"},"pageSize":{"type":"integer"},"items":{"type":"array","items":{}},"filters":{}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/reports/transfers":{"get":{"tags":["Relatórios"],"summary":"Transferências do período. Situação é a atual do atendimento, setor é o de destino, atendente é quem transferiu","operationId":"getReportsTransfers","x-scope":"read","parameters":[{"name":"period","in":"query","required":false,"description":"today, yesterday, 7d, month, 3m ou 6m (padrão 7d)","schema":{"type":"string"}},{"name":"from","in":"query","required":false,"description":"AAAA-MM-DD (com to, no lugar de period; até 180 dias)","schema":{"type":"string"}},{"name":"to","in":"query","required":false,"description":"AAAA-MM-DD","schema":{"type":"string"}},{"name":"q","in":"query","required":false,"description":"nome ou telefone","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"a partir de 1","schema":{"type":"string"}},{"name":"pageSize","in":"query","required":false,"description":"1 a 200, padrão 50","schema":{"type":"string"}},{"name":"status","in":"query","required":false,"description":"waiting, active, closed ou open (aguardando e em curso)","schema":{"type":"string"}},{"name":"sector","in":"query","required":false,"description":"id do setor ou none (sem setor)","schema":{"type":"string"}},{"name":"agent","in":"query","required":false,"description":"id da pessoa ou automation","schema":{"type":"string"}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"integer"},"page":{"type":"integer"},"pageSize":{"type":"integer"},"items":{"type":"array","items":{}},"filters":{}}}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Chave ausente, errada ou revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/openapi.json":{"get":{"tags":["Documentação"],"summary":"Este documento (OpenAPI 3.1), sem chave","operationId":"getOpenapiJson","x-scope":"public","security":[],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Pedido inválido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Não encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Estado não permite (humano no atendimento, atendimento concluído, Kanban desligado, conflito de versão)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Limite de uso justo (retry-after em segundos)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Chave de API criada no painel (Equipe → Chaves de API): Authorization: Bearer syncatende_…"}},"schemas":{"Error":{"type":"object","properties":{"error":{"type":"string"},"reason":{"type":"string"}},"required":["error"]},"Sector":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"isDefault":{"type":"boolean"},"active":{"type":"boolean"}}},"Agent":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"role":{"enum":["agent","admin"]},"active":{"type":"boolean"},"sectorId":{"type":["string","null"]},"sectorName":{"type":["string","null"]},"sectorIds":{"type":"array","items":{"type":"string"}},"allSectors":{"type":"boolean"}}},"Ticket":{"type":"object","properties":{"id":{"type":"string"},"customerName":{"type":["string","null"]},"phone":{"type":["string","null"]},"phonePending":{"type":"boolean"},"waId":{"type":["string","null"]},"subject":{"type":"string"},"status":{"enum":["waiting","active","closed"]},"sectorId":{"type":["string","null"]},"sectorName":{"type":["string","null"]},"assignedUserId":{"type":["string","null"]},"assignedName":{"type":["string","null"]},"unreadCount":{"type":"integer"},"lastMessage":{"type":"object","properties":{"text":{"type":["string","null"]},"at":{"type":"string"},"from":{"type":"string"}}},"lastTransfer":{"type":["object","null"]},"tags":{"type":"array","items":{"type":"string"}},"contactTags":{"type":"array","items":{"type":"string"}},"origin":{"type":"string"},"version":{"type":"integer"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"closedAt":{"type":["string","null"]}}},"Message":{"type":"object","properties":{"id":{"type":"string"},"direction":{"enum":["inbound","outbound"]},"author":{"type":"string"},"type":{"type":"string"},"text":{"type":["string","null"]},"replyTo":{"type":["string","null"]},"status":{"type":"string"},"statusAt":{"type":["string","null"]},"error":{},"source":{"type":"string"},"at":{"type":"string"},"choice":{},"interactive":{},"media":{"type":["object","null"],"properties":{"mime":{"type":["string","null"]},"filename":{"type":["string","null"]},"size":{"type":["integer","null"]},"available":{"type":"boolean"},"error":{"type":["string","null"]},"url":{"type":"string"}}}}},"Note":{"type":"object","properties":{"id":{"type":"string"},"text":{"type":"string"},"source":{"type":"string"},"author":{"type":["string","null"]},"apiKey":{"type":["string","null"]},"createdAt":{"type":"string"},"editedAt":{"type":["string","null"]}}},"HistoryEvent":{"type":"object","properties":{"id":{"type":"integer"},"action":{"type":"string"},"actorName":{"type":["string","null"]},"at":{"type":"string"},"sectorName":{"type":["string","null"]},"fromSectorName":{"type":["string","null"]},"assignedName":{"type":["string","null"]},"fromAssignedName":{"type":["string","null"]},"status":{"type":["string","null"]},"note":{"type":["string","null"]}}},"Contact":{"type":"object","properties":{"waId":{"type":"string"},"phone":{"type":"string"},"name":{"type":["string","null"]},"profileName":{"type":["string","null"]},"email":{"type":["string","null"]},"externalId":{"type":["string","null"]},"photoUrl":{"type":["string","null"]},"tags":{"type":"array","items":{"type":"string"}},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}},"ContactField":{"type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"position":{"type":"integer"}}},"ContactTag":{"type":"object","properties":{"tag":{"type":"string"},"color":{"type":["string","null"]},"contacts":{"type":"integer"}}},"Stage":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"color":{"type":"string"},"position":{"type":"integer"},"cards":{"type":"integer"},"totalCents":{"type":"integer"}}},"KanbanField":{"type":"object","properties":{"id":{"type":"string"},"key":{"type":"string"},"name":{"type":"string"},"position":{"type":"integer"},"cards":{"type":"integer"}}},"KanbanCard":{"type":"object","properties":{"id":{"type":"string"},"ticketId":{"type":"string"},"title":{"type":"string"},"phone":{"type":["string","null"]},"stage":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":["string","null"]}}},"ownerUserId":{"type":["string","null"]},"ownerName":{"type":["string","null"]},"valueCents":{"type":["integer","null"]},"dueDate":{"type":["string","null"],"format":"date"},"note":{"type":["string","null"]},"ticketClosed":{"type":"boolean"},"otherSector":{"type":"boolean"},"sectorId":{"type":["string","null"]},"version":{"type":"integer"},"tags":{"type":"array","items":{"type":"string"}},"fields":{"type":"object","additionalProperties":{"type":"string"}},"createdAt":{"type":"string"},"movedAt":{"type":"string"},"updatedAt":{"type":"string"}}},"CardPatch":{"type":"object","properties":{"stageId":{"type":"string"},"ownerUserId":{"type":["string","null"]},"valueCents":{"type":["integer","null"]},"dueDate":{"type":["string","null"]},"note":{"type":["string","null"]},"tags":{"type":"array","items":{"type":"string"}},"fields":{"type":"object","additionalProperties":{"type":["string","null"]}},"version":{"type":"integer"}}},"Webhook":{"type":"object","properties":{"url":{"type":"string"},"events":{"type":"array","items":{"type":"string"}},"lastDelivery":{"type":["object","null"]}}},"Template":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"title":{"type":"string"},"language":{"type":"string"},"category":{"enum":["MARKETING","UTILITY","AUTHENTICATION"]},"categoryLabel":{"type":"string"},"requestedCategory":{"type":["string","null"]},"status":{"type":"string"},"statusKey":{"enum":["approved","pending","rejected","paused","disabled","other"]},"statusLabel":{"type":"string"},"quality":{"enum":["GREEN","YELLOW","RED","UNKNOWN"]},"qualityLabel":{"type":"string"},"reject":{"type":["object","null"],"properties":{"code":{"type":["string","null"]},"text":{"type":["string","null"]}}},"statusDetail":{"type":["object","null"]},"categoryNotice":{"type":["object","null"]},"source":{"enum":["system","meta"]},"usable":{"type":"boolean"},"unsupportedReason":{"type":["string","null"]},"canSend":{"type":"boolean"},"canEdit":{"type":"boolean"},"editBlockedReason":{"type":["string","null"]},"variables":{"type":"object","properties":{"header":{"type":"array","items":{"type":"string"}},"body":{"type":"array","items":{"type":"string"}}}},"preview":{"type":"object"},"hasSample":{"type":"boolean"},"version":{"type":"integer"},"lastSyncedAt":{"type":["string","null"]},"createdAt":{"type":["string","null"]},"updatedAt":{"type":["string","null"]}}},"TemplateInput":{"type":"object","properties":{"title":{"type":"string"},"category":{"enum":["MARKETING","UTILITY"]},"language":{"enum":["pt_BR"]},"utilityDeclared":{"type":"boolean"},"stopButton":{"type":"boolean"},"header":{"type":"object","properties":{"type":{"enum":["TEXT","IMAGE","VIDEO","DOCUMENT"]},"text":{"type":"string"},"example":{"type":"string"}}},"body":{"type":"object","properties":{"text":{"type":"string"},"examples":{"type":"object","additionalProperties":{"type":"string"}}},"required":["text"]},"footer":{"type":"string"},"buttons":{"type":"array","items":{"type":"object","properties":{"type":{"enum":["QUICK_REPLY","URL","PHONE_NUMBER","COPY_CODE"]},"text":{"type":"string"},"url":{"type":"string"},"example":{"type":"string"},"phone":{"type":"string"}}}},"sample":{"type":"object","properties":{"data":{"type":"string"},"mime":{"type":"string"},"filename":{"type":"string"}}}},"required":["title","category","body"]},"Funnel":{"type":"object","properties":{"total":{"type":"integer"},"queued":{"type":"integer"},"sending":{"type":"integer"},"sent":{"type":"integer"},"delivered":{"type":"integer"},"read":{"type":"integer"},"failed":{"type":"integer"},"skipped":{"type":"integer"},"canceled":{"type":"integer"},"unknown":{"type":"integer"},"replied":{"type":"integer"},"done":{"type":"number"}}},"Campaign":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"status":{"enum":["scheduled","running","paused","completed","canceled"]},"statusLabel":{"type":"string"},"pauseReason":{"type":["string","null"]},"pauseKind":{"enum":["user","auto","template","account",null]},"template":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"language":{"type":"string"},"category":{"enum":["MARKETING","UTILITY"]},"categoryLabel":{"type":"string"}}},"audience":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string"}},"exclude":{"type":"array","items":{"type":"string"}}}},"progress":{"$ref":"#/components/schemas/Funnel"},"scheduledAt":{"type":["string","null"]},"startedAt":{"type":["string","null"]},"finishedAt":{"type":["string","null"]},"createdAt":{"type":"string"},"pausedAt":{"type":["string","null"]},"canceledAt":{"type":["string","null"]},"window":{"type":"object"},"pacing":{"type":"object","properties":{"mode":{"enum":["auto","random"]},"minSeconds":{"type":["number","null"]},"maxSeconds":{"type":["number","null"]}}},"rate":{"type":"integer"},"reply":{"type":"object","properties":{"sectorId":{"type":"string"},"tag":{"type":"string"},"attributionHours":{"type":"integer"}}},"optIn":{"type":"object","properties":{"source":{"type":["string","null"]},"declaredAt":{"type":["string","null"]},"declaredBy":{"type":["string","null"]}}},"targetStage":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":["string","null"]}}},"recipients":{"type":"integer"},"excluded":{"type":"object","additionalProperties":{"type":"integer"}},"waiting":{"type":["object","null"]},"version":{"type":"integer"}}},"CampaignInput":{"type":"object","properties":{"name":{"type":"string"},"templateId":{"type":"string"},"audience":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"}},"tagsMode":{"enum":["any","all"]},"stageIds":{"type":"array","items":{"type":"string"}},"sheet":{"type":"object","properties":{"data":{"type":"string"},"filename":{"type":"string"},"contacts":{"type":"array","items":{"type":"object","properties":{"phone":{"type":"string"},"name":{"type":"string"},"data":{"type":"object","additionalProperties":{"type":"string"}}}}},"mapping":{"type":"object","properties":{"phoneColumn":{"type":"integer"},"nameColumn":{"type":"integer"},"sheet":{"type":["integer","string"]}}}}},"listId":{"type":"string"},"numbers":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"allContacts":{"type":"boolean"},"confirmAllContacts":{"type":"boolean"},"failedFrom":{"type":"string"},"include":{"type":"array","items":{"type":"object"}},"exclude":{"oneOf":[{"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"}},"stageIds":{"type":"array","items":{"type":"string"}},"sheet":{"type":"object","properties":{"data":{"type":"string"},"filename":{"type":"string"}}},"numbers":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]}}},{"type":"array","items":{"type":"object"}}]},"frequencyDays":{"type":"integer"},"skipActive":{"type":"boolean"}}},"variables":{"type":"object","additionalProperties":{"type":"object","properties":{"from":{"enum":["first_name","name","phone","fixed","column","field","previous","contact.firstName","contact.name","contact.phone"]},"value":{"type":"string"},"column":{"type":"string"},"field":{"type":"string"},"default":{"type":"string"}}}},"buttonVariables":{"type":"object","additionalProperties":{"type":"object","properties":{"from":{"enum":["tracking","fixed","first_name","name","phone","column","field","previous"]},"value":{"type":"string"},"default":{"type":"string"}}}},"header":{"type":"object","properties":{"link":{"type":"string"}}},"schedule":{"type":"object","properties":{"at":{"type":"string"},"window":{"type":["object","null"]}}},"pacing":{"type":"object","properties":{"mode":{"enum":["auto","random"]},"minSeconds":{"type":"number"},"maxSeconds":{"type":"number"}}},"reply":{"type":"object","properties":{"sectorId":{"type":"string"},"attributionHours":{"type":"integer"},"targetStageId":{"type":"string"}}},"optIn":{"type":"object","properties":{"source":{"enum":["whatsapp","form","store","event","other"]},"sourceText":{"type":"string"},"declaration":{"type":"boolean"}}},"launch":{"type":"boolean"},"requestId":{"type":"string"}},"required":["name","templateId","audience","reply","optIn"]},"CampaignMessage":{"type":"object","properties":{"id":{"type":"string"},"seq":{"type":"integer"},"name":{"type":"string"},"phone":{"type":"string"},"state":{"type":"string"},"stateLabel":{"type":"string"},"skipReason":{"type":["string","null"]},"skipLabel":{"type":["string","null"]},"attempts":{"type":"integer"},"errorCode":{"type":["integer","null"]},"error":{"type":["string","null"]},"sentAt":{"type":["string","null"]},"deliveredAt":{"type":["string","null"]},"readAt":{"type":["string","null"]},"failedAt":{"type":["string","null"]},"repliedAt":{"type":["string","null"]},"wave":{"type":["integer","null"]}}},"BroadcastList":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"filename":{"type":["string","null"]},"total":{"type":"integer"},"valid":{"type":"integer"},"rejected":{"type":"integer"},"headers":{"type":"array","items":{"type":"object"}},"phoneColumn":{"type":["string","null"]},"nameColumn":{"type":["string","null"]},"report":{"type":["object","null"]},"createdAt":{"type":["string","null"]},"lastUsedAt":{"type":["string","null"]}}},"Suppression":{"type":"object","properties":{"last4":{"type":"string"},"phone":{"type":"string"},"scope":{"enum":["marketing","all"]},"reason":{"type":"string"},"campaignId":{"type":["string","null"]},"createdAt":{"type":["string","null"]}}},"WebhookItem":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"},"events":{"type":"array","items":{"type":"string"}},"active":{"type":"boolean"},"lastDelivery":{"type":["object","null"],"properties":{"event":{"type":"string"},"status":{"type":["integer","null"]},"error":{"type":["string","null"]},"at":{"type":"string"}}}}}}}}