Aller au contenu

Lista as variáveis por destinatário

GET/api/campaigns/variables

Auth
Jeton requis
Clé d’API:
campaigns:read
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.

Owner, admin, moderador e financeiro. As variáveis que o assunto, o pré-cabeçalho, a introdução e os blocos de texto e botão aceitam, cada uma com o nome do campo, o que mostra e um exemplo no idioma de quem pede. A sintaxe é `{{nome}}` ou, com texto para quando a pessoa não tem o dado, `{{lider|nossa equipe}}`; sem esse texto a variável vazia some sem deixar espaço duplo. O nome aceita a chave em português (`key`) ou o apelido em inglês (`aliases`), sem diferença de maiúsculas. Os valores são carregados em lote quando o disparo entra na fila; o envio de teste e a prévia usam os dados de quem pediu. `lider` é o líder direto no organograma e, sem ele, os líderes dos grupos da pessoa; `pontos`, `nivel`, `nivel_numero` e `posicao_ranking` vêm do Engajamento da comunidade (desde 2026-10-31, `nivel` é o nome do nível, como "Colaborador" ou o nome que a comunidade deu; o número passou para `nivel_numero`); `plano` são as assinaturas ativas. Nada de e-mail, telefone, documento ou valor. Uma variável que não existe no texto é recusada com 400 ao salvar, enviar ou agendar. Cada campo customizado ativo da comunidade (`GET /api/member-fields`) entra no fim da lista como `{{campo_<key>}}` (apelido `{{field_<key>}}`), com `group: customFields` e o rótulo do campo em `label`; as variáveis de sempre vêm com `group: standard`. O valor sai formatado para quem recebe: data no idioma da pessoa e no fuso da comunidade, número no formato do idioma, sim/não traduzido, seleção pelo rótulo da opção. Campo apagado sai da lista, e a variável dele passa a ser recusada ao salvar.

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.

Réponses

StatutDescription
200As variáveis.
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 GET "https://api.memberfy.net/api/campaigns/variables" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID"