Salva a versão de um idioma do e-mail padrão
PUT/api/email-overrides/{emailKey}/{language}
- Auth
- Exige token
- Quem pode:
- owner
- admin
- Chave de API:
- reports:write
- X-CommunityId
X-CommunityIdEnvie o X-CommunityId da comunidade em que a operação acontece.
(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
| Nome | Onde | Tipo | Descrição |
|---|---|---|---|
emailKeyobrigatório | path | string | |
languageobrigatório | path | string |
Headers
| Nome | Tipo | Descrição |
|---|---|---|
If-Unmodified-Sinceopcional | string | Opcional: 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-CommunityIdopcional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Corpo da requisição application/json
| Nome | Tipo | Descrição |
|---|---|---|
subjectopcional | string | max 300 |
preheaderopcional | string | max 300 |
introopcional | string | |
blocksopcional | object[] | |
enabledopcional | boolean | |
emailIdopcional | string (uuid) |
Respostas
| Código | Descrição |
|---|---|
200 | A versão salva. |
401 | Token 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`). |
403 | Autenticado, mas sem permissão para esta operação. |
404 | Recurso não encontrado. |
409 | Outra 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`). |
422 | Bloco travado faltando, bloco dinâmico, variável que não existe (um erro por campo). |
500 | Erro interno do servidor. |
Exemplo com 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 '{}'