notices

POST /v1/notices/{noticeId}/dismiss

The customer closed a notice.

Todos os endpoints de notices

Autenticação

Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.

Onde vai o ID da sua organização

Este endpoint aceita org_id como parâmetro de consulta. Omita-o e a chamada abrangerá toda a sua subárvore de locatários; envie-o para restringir a chamada a uma única organização.

O ID da sua organização está na tela de chaves de API no seu painel, ao lado da própria chave. É o mesmo ID em todas as chamadas que você fizer.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

curl -X POST https://api.zinndigital.com/v1/notices/{noticeId}/dismiss \
  -H "Authorization: Bearer zdk_live_…"

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

Per **user**, not per organization — a colleague dismissing a promotion must not remove it from everyone else's dashboard. Idempotent, and `204` whether or not the id resolved: "I have closed this" cannot fail from the customer's side, and answering differently for an id they are not in the audience for would confirm that a notice exists.

Parâmetros

NomeTipoObrigatórioO que é
noticeId (path)stringSim
org_id (query)stringNão

Erros que este endpoint pode retornar

401 · 429