Mandar um aviso no app (sino) para pessoas da comunidade
POST/api/notifications/send
- 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) 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
| 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. |
Request body application/json
| Name | Type | Description |
|---|---|---|
memberIdsrequired | string (uuid)[] | |
titlerequired | string | max 120 |
bodyoptional | string | max 500 |
Responses
| Status | Description |
|---|---|
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. |
curl example
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"}'