Aller au contenu

Define minha preferência de e-mail

PUT/api/members/me/email-preferences

Auth
Jeton requis
Clé d’API:
preferences:write
X-CommunityId
X-CommunityId Envoyez 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.

Grava a mesma preferência que os links de descadastro (origem `profile`), só na comunidade do `X-CommunityId`. Mande `shortcut` (`all` liga todas, `campaigns-off` desliga só os comunicados, `none` desliga todas), `categories` (`{ chave: true|false }`; as chaves omitidas ficam como estão) ou os dois (o mapa vence o atalho). O `scope` antigo continua aceito (`null` liga tudo, `CAMPAIGNS` desliga os comunicados, `ALL` desliga tudo). Segurança, recibos e avisos legais sempre chegam.

En-têtes

NomTypeDescription
X-CommunityIdfacultatifstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Corps de la requête application/json

NomTypeDescription
shortcutfacultatifall | campaigns-off | none
categoriesfacultatifobject
scopefacultatifCAMPAIGNS | ALLMantido por compatibilidade.

Réponses

StatutDescription
200Preferência resultante.
400Requisição inválida — falha de validação.
401Token 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`).
403Autenticado, mas sem permissão para esta operação.
500Erro interno do servidor.

Exemple curl

curl -X PUT "https://api.memberfy.net/api/members/me/email-preferences" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{}'