Lista quem se descadastrou
GET/api/campaigns/opt-outs
- Auth
- Jeton requis
- Clé d’API:
- campaigns:read
- X-CommunityId
X-CommunityIdEnvoyez le X-CommunityId de la communauté où l’opération a lieu.
Les descriptions des endpoints viennent directement de la spécification de l’API et sont en portugais pour l’instant. L’interface autour est traduite.
Owner, admin, moderador e financeiro. Mais recentes primeiro. O e-mail vem mascarado e nunca há token. `source` diz de onde veio a escolha (`link`, `one-click` ou `profile`).
Paramètres
| Nom | Emplacement | Type | Description |
|---|---|---|---|
pagefacultatif | query | integer | |
limitfacultatif | query | integer |
En-têtes
| Nom | Type | Description |
|---|---|---|
X-CommunityIdfacultatif | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Réponses
| Statut | Description |
|---|---|
200 | Página de descadastros. |
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. |
Exemple curl
curl -X GET "https://api.memberfy.net/api/campaigns/opt-outs" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID"