Anotações
Grupo Anotações da API: criação, consulta, listagem e exclusão de anotações internas vinculadas a tickets — o mesmo recurso da aba Anotações da tela de atendimento (a nota não é enviada ao cliente; ao criar, também é gerada a mensagem interna correspondente no ticket e as notificações de menção, igual no painel).
🔐 Autenticação igual aos demais endpoints: token no cabeçalho
Authorization: Bearer(veja Introdução e Autenticação). O autor da anotação é o usuário vinculado ao token da API. Todas as operações retornam apenas anotações da mesma empresa (tenant) do token — registro de outra empresa retorna404.
1. Criar anotação em um ticket
Método:
POSTEndpoint:
/ticketnoteResposta de sucesso:
201com objetoticketNote(id,note,ticketId,contactId,userId,messageId,tenantId,createdAt,updatedAt)
Corpo (JSON):
note
string
✅ Sim
Texto da anotação (mínimo de 3 caracteres). Menções (@usuário/@equipe) são adicionadas automaticamente pelo sistema
ticketId
number
Condicional
ID do ticket. Use ticketId OU number, nunca os dois ao mesmo tempo
number
string
Condicional
Número do contato. A nota vai para o último ticket do contato na conexão (canal) do token — igual ao comportamento do endpoint /showticket
userIdNotification
array de string
❌ Opcional
IDs (como string) dos usuários a mencionar — gera mensagem no Chat Interno e notificação push. Ex.: ["5"]
equipeIdNotification
array de string
❌ Opcional
IDs (como string) das equipes/grupos a mencionar — gera mensagem no Chat Interno e log no ticket. Ex.: ["2"]
{
"ticketId": 2881,
"note": "Cliente pediu retorno amanhã"
}Variante por número (sem ticketId):
{
"number": "551198985414",
"note": "Cliente pediu retorno amanhã"
}Com menções:
Respostas de erro:
400
note ausente ou com menos de 3 caracteres; ou ticketId e number enviados juntos
404
Ticket não encontrado (não existe, é de outra empresa ou não há ticket para o número na conexão do token)
2. Consultar uma anotação
Método:
GETEndpoint:
/ticketnote/{id}Path:
id(integer) — ID da anotaçãoResposta de sucesso:
200com o objetoticketNote(texto, autor, ticket, contato, datas)
Respostas de erro: 404 — anotação não encontrada (não existe ou é de outra empresa).
3. Apagar uma anotação
Método:
DELETEEndpoint:
/ticketnote/{id}Path:
id(integer) — ID da anotaçãoComportamento: remove a anotação e a mensagem interna correspondente no ticket (mesmo comportamento da exclusão pelo painel), registrando log de deleção
Resposta de sucesso:
200
Respostas de erro: 404 — anotação não encontrada (não existe ou é de outra empresa).
4. Listar anotações de um ticket
Método:
GETEndpoint:
/ticketnote/ticket/{id}Path:
id(integer) — ID do ticketResposta de sucesso:
200comticketNotes— todas as anotações do ticket, da mais recente para a mais antiga, com o nome do autor
Respostas de erro: 404 — ticket não encontrado (não existe ou é de outra empresa).
5. Listar anotações de um contato
Método:
GETEndpoint:
/ticketnote/contact/{id}Identificação do contato: pelo
contactIdno path ou pelonumberna query string (/ticketnote/contact/?number=551198985414)Resposta de sucesso:
200comticketNotes— todas as anotações dos tickets do contato, da mais recente para a mais antiga. Contato sem anotações retorna lista vazia
Respostas de erro:
400
Nenhum identificador informado (faltou contactId no path e number na query)
💡 Não existe endpoint de edição: para alterar o texto de uma anotação, apague (
DELETE /ticketnote/{id}) e crie novamente com o texto atualizado.
Atualizado
