Mandar um aviso no app (sino) para pessoas da comunidade
POST/api/notifications/send
- Auth
- Requiere token
- Clave de API:
- No acepta clave de API
- X-CommunityId
X-CommunityIdEnvía el X-CommunityId de la comunidad en la que ocurre la operación.
Las descripciones de los endpoints vienen de la especificación de la API y, por ahora, están en portugués. La interfaz alrededor está traducida.
A equipe (owner, admin, moderador) manda um aviso `team.notice` para até 100 pessoas da comunidade do `X-CommunityId`: aparece no sino de cada uma, em tempo real, com o título e o texto que a equipe escreveu. Não manda e-mail. É a mesma ação "Mandar aviso no app" (`notification.send`) do nó "Ação da plataforma" dos workflows. Pessoa fora da comunidade (ou removida) vai em `failed`, sem impedir as outras.
Headers
| Nombre | Tipo | Descripción |
|---|---|---|
X-CommunityIdopcional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Cuerpo de la solicitud application/json
| Nombre | Tipo | Descripción |
|---|---|---|
memberIdsobligatorio | string (uuid)[] | |
titleobligatorio | string | max 120 |
bodyopcional | string | max 500 |
Respuestas
| Código | Descripción |
|---|---|
200 | Avisos criados (`sent`) e os que não foram (`failed`, com o motivo). |
400 | Requisição inválida — falha de validação. |
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. |
500 | Erro interno do servidor. |
Ejemplo con curl
curl -X POST "https://api.memberfy.net/api/notifications/send" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{"memberIds":["00000000-0000-0000-0000-000000000000"],"title":"string"}'