Salva a versão de um idioma do e-mail padrão
PUT/api/email-overrides/{emailKey}/{language}
- Auth
- Requires a token
- Who can call it:
- owner
- admin
- API key:
- reports:write
- X-CommunityId
X-CommunityIdSend the X-CommunityId of the community the operation happens in.
Endpoint descriptions come straight from the API specification and are in Portuguese for now. The interface around them is translated.
(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.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
emailKeyrequired | path | string | |
languagerequired | path | string |
Headers
| Name | Type | Description |
|---|---|---|
If-Unmodified-Sinceoptional | 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-CommunityIdoptional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Request body application/json
| Name | Type | Description |
|---|---|---|
subjectoptional | string | max 300 |
preheaderoptional | string | max 300 |
introoptional | string | |
blocksoptional | object[] | |
enabledoptional | boolean | |
emailIdoptional | string (uuid) |
Responses
| Status | Description |
|---|---|
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. |
curl example
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 '{}'