Saltar al contenido

Liga, desliga e ajusta um e-mail automático

PUT/api/campaigns/automatic/{systemKey}

Auth
Requiere token
Quién puede:
owner
admin
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.

**Só owner e admin.** Todos os campos são opcionais. `enabled: true` **liga o envio em massa recorrente** e exige `consent: true` na primeira vez (a confirmação de que são membros da comunidade e aceitam comunicados; fica guardada); agenda o próximo disparo no dia e hora (fuso da comunidade). `enabled: false` impede o próximo envio. Também edita `subject`, `intro` (HTML sanitizado; apresenta o conteúdo, mas **sozinho não dispara nada**), `weekdays` (0 = domingo), `timeOfDay` e `blocks` (lista de `posts`, `courses`, `events`, `classifieds`). Semana sem nada novo: o disparo é pulado e registrado. Respeita descadastro e supressão, só traz conteúdo visível a todo o público e **conta na cota** de disparos; sem cota, o disparo é pulado e o owner recebe um aviso por e-mail (uma vez por disparo). `systemKey` desconhecida é 404.

Parámetros

NombreDóndeTipoDescripción
systemKeyobligatoriopathWEEKLY_DIGEST

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
enabledopcionalboolean
consentopcionalboolean
subjectopcionalstringmax 300
introopcionalstring
weekdaysopcionalinteger[]
timeOfDayopcionalstring
blocksopcionalposts | courses | events | classifieds[]

Respuestas

CódigoDescripción
200O automático atualizado.
400Requisição inválida — falha de validação.
401Token ausente, inválido ou expirado.
403Autenticado, mas sem permissão para esta operação.
404Recurso não encontrado.
422Consentimento ausente ao ligar, dia, hora ou blocos inválidos.
500Erro interno do servidor.

Ejemplo con curl

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