Saltar al contenido
memberfy
AR

Liga o workflow

POST/api/workflows/{id}/activate

Auth
Requiere token
Quién puede:
owner
admin
Clave de API:
No acepta clave de API
X-CommunityId
X-CommunityId Envía el X-CommunityId de la comunidad en la que ocurre la operación.
Las descripciones de los endpoints vienen de la especificación de la API y, por ahora, están en portugués. La interfaz alrededor está traducida.

**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.

Parámetros

NombreDóndeTipoDescripción
idobligatoriopathstring (uuid)

Headers

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

Cuerpo de la solicitud application/json

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

Respuestas

CódigoDescripción
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.

Ejemplo con 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 '{}'