Skip to content

Lista as variáveis por destinatário

GET/api/campaigns/variables

Auth
Requires a token
X-CommunityId
X-CommunityId Send 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.

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` e `posicao_ranking` vêm do ranking geral da comunidade; `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.

Headers

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

Responses

StatusDescription
200As variáveis.
401Token ausente, inválido ou expirado.
403Autenticado, mas sem permissão para esta operação.
500Erro interno do servidor.

curl example

curl -X GET "https://api.memberfy.net/api/campaigns/variables" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID"