Pular para o conteúdo
Equipe

Avisar uma pessoa do time

v1.0.0
POSThttps://api.staging.growthaisystem.com/api/v1/notifications
  • ExigeAuthorization: Bearer gos_…— Chave de API (gos_…)· escoposnotifications.write

Põe um aviso no sino de UMA pessoa do time — o mesmo aviso da automação "Avisar alguém". userId omitido = o dono da conta. Com opportunityId (ou contactId), o clique no aviso abre o negócio (ou o contato). alsoEmail: true manda também um e-mail interno, em melhor esforço: se o e-mail falhar, o aviso continua no sino e note diz.

O aviso mostra como origem Integração: <nome da chave>. Passa pela Ação notify.user do Núcleo de Ações (auditada; aceita Idempotency-Key).

Corpo da requisição

application/jsonobrigatório
  • userIdstringopcional
    • tamanho mín. 1
  • titlestringobrigatório
    • tamanho 1–120
  • messagestring | nullopcional
    • tamanho máx. 2000
  • contactIdstringopcional
    • tamanho mín. 1
  • opportunityIdstringopcional
    • tamanho mín. 1
  • alsoEmailbooleanopcional
    • padrão false

Respostas

11 respostas documentadas — o código, o que ele significa nesta rota e a forma do corpo.

201Deu certoapplication/json

O aviso entrou no sino de quem recebeu. Repetir a Idempotency-Key devolve o mesmo aviso, sem um segundo.

V1NotificationSent

  • idstring
  • userIdstring
  • emailSentboolean
  • notestring | null