Aller au contenu
memberfy
FR

Liga o workflow

POST/api/workflows/{id}/activate

Auth
Jeton requis
Qui peut l’appeler:
owner
admin
Clé d’API:
Clé d’API non acceptée
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.

**Manda e-mail** (a partir dos próximos gatilhos, nunca retroativo). Só owner e admin. O desenho é validado de novo (um e-mail pode ter sido excluído). O MCP pede confirmação antes. Um gatilho por tempo alcança quem já está na base: na primeira vez pede `consent: true` (a mesma declaração das campanhas), senão 422 `workflows.consentRequired`. Em `time.no_access`, `includeExisting: true` inclui também, uma única vez, quem já está há mais de N dias sem acesso: uma passada diária a partir das 9h no fuso da comunidade, no ritmo do limite diário de e-mails da comunidade, uma entrada por pessoa; depois segue só a passada diária normal. Pede `consent: true` toda vez (senão 422 `workflows.consentRequired`); em outro gatilho, 422 `workflows.includeExistingUnsupported`. A estimativa (`people.existing`) mostra quantas pessoas são.

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

NomTypeDescription
consentfacultatifbooleanGatilho por tempo: confirma que as pessoas são membros e aceitam receber comunicados.
includeExistingfacultatifbooleanSó `time.no_access`: inclui, uma vez, quem já passou dos N dias sem acesso. Exige `consent: true`.

Réponses

StatutDescription
200O workflow, ligado.
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.
409O envio da comunidade está suspenso (`data.code: SENDING_SUSPENDED`, `sendingSuspendedUntil`, `untilLifted`, `reason`).
422Desenho inválido; falta `consent: true` num gatilho por tempo ou com `includeExisting`; `includeExisting` fora de `time.no_access` (`workflows.includeExistingUnsupported`) ou não booleano (`workflows.includeExistingInvalid`); fase 5: o plano já tem o máximo de workflows ligados (`workflows.workflowsLimitReached`, `data: { code: WORKFLOWS_LIMIT_REACHED, maxActive, activeCount, upgrade: { screen: billing } }`; o override do SuperAdmin vale sobre o plano). Um desenho antigo sem fins explícitos é lido com "Fim: sucesso" nos ramos soltos.
500Erro interno do servidor.

Exemple curl

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