Saltar al contenido

Salva a versão de um idioma do e-mail padrão

PUT/api/email-overrides/{emailKey}/{language}

Auth
Requiere token
Quién puede:
owner
admin
Clave de API:
reports:write
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.

(critérios 2, 4, 5). **Muda e-mails que a comunidade manda.** Só owner e admin. Cria a personalização e o seu e-mail da biblioteca na primeira gravação (ou liga um e-mail da biblioteca feito para esta chave, `emailId`). Regras: cada bloco travado da chave uma vez (`{ type: systemSlot, slot }`; faltando: 422 com `data.missingSlots`), sem blocos dinâmicos (posts, cursos, eventos, produtos), só as variáveis da chave e as baratas (`nome`, `nome_completo`, `comunidade`, `membro_desde`). A categoria e o descadastro são os do e-mail padrão; recibo e ingresso continuam sempre enviados, sem link de descadastro. Não conta na cota de campanhas.

Parámetros

NombreDóndeTipoDescripción
emailKeyobligatoriopathstring
languageobligatoriopathstring

Headers

NombreTipoDescripción
If-Unmodified-SinceopcionalstringOpcional: a versão lida (`versions[].updatedAt` daquele idioma), como data HTTP, se não vier `updatedAt` no corpo. Outra gravação depois dela responde 409.
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
subjectopcionalstringmax 300
preheaderopcionalstringmax 300
introopcionalstring
blocksopcionalobject[]
enabledopcionalboolean
emailIdopcionalstring (uuid)

Respuestas

CódigoDescripción
200A versão salva.
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.
409Outra gravação veio antes da versão enviada (`updatedAt` no corpo ou `If-Unmodified-Since`); `data.updatedAt` é a versão atual: recarregue e repita. Cada gravação avisa os editores abertos (`item.saved`, ver `POST /api/realtime/ticket`).
422Bloco travado faltando, bloco dinâmico, variável que não existe (um erro por campo).
500Erro interno do servidor.

Ejemplo con curl

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