Quem abriu e quem não abriu um envio de avisos do sino
GET/api/notifications/sends/{sendId}
- Auth
- Requires a token
- API key:
- No API key accepted
- X-CommunityId
X-CommunityIdSend the X-CommunityId of the community the operation happens in.
Endpoint descriptions come straight from the API specification and are in Portuguese for now. The interface around them is translated.
A equipe (owner, admin, moderador) lê um envio de avisos do sino da comunidade do `X-CommunityId`: o aviso da equipe (`POST /api/notifications/send`, que devolve o `sendId`), o de um workflow (o `sendId` é a execução) e o lembrete de confirmação de leitura de um post (`POST /api/content/{id}/acknowledgements/remind`). "Abriu" é o aviso marcado como lido (`readAt`). Cada pessoa vem com `read`, `readAt` e `removed` (ela apagou o aviso do sino; continua contada). Membro e financeiro: 403. Envio de outra comunidade ou que não existe: 404.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
sendIdrequired | path | string | |
statusoptional | query | all | read | unread | |
pageoptional | query | integer | |
limitoptional | query | integer |
Headers
| Name | Type | Description |
|---|---|---|
X-CommunityIdoptional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Responses
| Status | Description |
|---|---|
200 | O envio com as contagens (sempre do envio inteiro) e a página de pessoas. |
401 | Token ausente, inválido ou expirado; token de outra comunidade (o `X-CommunityId` ou o `communityId` do corpo não é o do token); token antigo ou de uma sessão encerrada (troca de senha, convite aceito). Nesses casos a mensagem pede para entrar de novo (`auth.signInAgain`). |
403 | Autenticado, mas sem permissão para esta operação. |
404 | Recurso não encontrado. |
500 | Erro interno do servidor. |
curl example
curl -X GET "https://api.memberfy.net/api/notifications/sends/<sendId>" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID"