Aller au contenu

Envia um teste para quem pediu

POST/api/campaigns/{id}/test

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

Owner, admin, moderador e financeiro. Envia o e-mail só para o e-mail de quem está logado, com `[Teste]` no assunto. Não conta na cota, não cria disparo e mesmo quem se descadastrou recebe o próprio teste. As variáveis (`{{nome}}`, `{{lider}}`, `{{pontos}}`…) saem com os dados de quem pediu. Limite de 10 testes por hora por pessoa.

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring (uuid)

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

La spécification ne déclare pas les champs de ce corps (un envoi multipart, par exemple). Consultez le guide du thème.

Réponses

StatutDescription
200Teste na fila.
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.
404Recurso não encontrado.
422Assunto vazio.
429Mais de 10 testes na última hora.
500Erro interno do servidor.

Exemple curl

curl -X POST "https://api.memberfy.net/api/campaigns/<id>/test" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{}'