Salva um bloco de um idioma do e-mail (edição em equipe)
PUT/api/emails/{id}/versions/{language}/blocks/{blockId}
- Auth
- Richiede un token
- Chi può:
- owner
- admin
- moderator
- finance
- Chiave API:
- reports:write
- X-CommunityId
X-CommunityIdInvia l’X-CommunityId della community in cui avviene l’operazione.
Le descrizioni degli endpoint provengono dalla specifica dell’API e per ora sono in portoghese. L’interfaccia intorno è tradotta.
Owner, admin, moderador e financeiro (e-mail de um e-mail padrão: só owner e admin). Grava **um bloco** da versão daquele idioma, achado pelo `id` dele, com as mesmas regras do `PUT /api/emails/{id}/versions/{language}`. Não confere a versão: duas pessoas salvando blocos diferentes nunca recebem 409. Vale para os próximos envios de todos os disparos que usam o e-mail, como a versão inteira.
**Trava de edição (F-174):** bloco aberto por outra pessoa no editor: **423** com o nome dela. Quem está editando recebe o bloco salvo no WebSocket (`block.saved` na sala `item:email:{id}`).
Parametri
| Nome | Dove | Tipo | Descrizione |
|---|---|---|---|
idobbligatorio | path | string (uuid) | |
languageobbligatorio | path | string | |
blockIdobbligatorio | path | string | O `id` do bloco (`versions[].blocks[].id` do `GET`). |
Header
| Nome | Tipo | Descrizione |
|---|---|---|
X-CommunityIdfacoltativo | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Corpo della richiesta application/json
| Nome | Tipo | Descrizione |
|---|---|---|
blockobbligatorio | object | Bloco do corpo, na ordem em que aparece. Estáticos: `text`, `button`, `image`. Dinâmicos (lidos **uma vez por disparo, na hora do envio**, só de conteúdo que todo o público pode ver: aprovado, no ar, em espaço e seção abertos a todos os membros, sem plano, grupo ou produto exigido): `latestPosts`, `upcomingEvents`, `newCourses` (cursos publicados desde o disparo anterior), `newClassifieds` (anúncios novos), `course`, `event` e `product`. Um item que deixou de ser visível some do e-mail; ao salvar, um item fixo que não é visível a todos é recusado (422 em `blocks[i]`). Nunca vai conteúdo pago no corpo: o produto é um cartão com link para a loja. |
block.idfacoltativo | string | F-174: identificador persistido do bloco (a trava de edição e a gravação de um bloco só, `PUT …/blocks/{blockId}`, usam ele). Mande de volta o que veio no `GET`; bloco sem `id` (ou com um repetido na lista) ganha um novo ao salvar. · max 64 |
block.typeobbligatorio | text | button | image | latestPosts | upcomingEvents | course | event | product | newCourses | newClassifieds | |
block.htmlfacoltativo | string | Só em `text`. HTML rico, sanitizado como nos posts. `{{nome}}` vira o primeiro nome de cada pessoa. |
block.textfacoltativo | string | Só em `button`. · max 80 |
block.urlfacoltativo | string | Em `button` (destino) e `image` (endereço; use o de `POST /api/upload/campaigns/image` ou outro https). Só http ou https. |
block.altfacoltativo | string | Só em `image`. · max 200 |
block.countfacoltativo | integer | Em `latestPosts`, `upcomingEvents`, `newCourses` e `newClassifieds`: quantos itens. · ≥ 1, ≤ 10 |
block.spaceIdfacoltativo | string (uuid) | Em `latestPosts`: o espaço de conteúdo (nulo = todos os abertos). |
block.withinDaysfacoltativo | integer | Em `upcomingEvents`: janela a partir do dia do envio. · ≥ 1, ≤ 90 |
block.headingfacoltativo | string | Em `latestPosts` e `upcomingEvents`: título da seção (padrão traduzido). · max 80 |
block.courseIdsfacoltativo | string (uuid)[] | Em `course`: de 1 a 6 cursos, na ordem em que aparecem. Ver `productIds`. |
block.eventIdsfacoltativo | string (uuid)[] | Em `event`: de 1 a 6 eventos, na ordem em que aparecem. Ver `productIds`. |
block.productIdsfacoltativo | string (uuid)[] | Em `product`: de 1 a 6 produtos, sem repetidos, na ordem em que aparecem. Um item mostra o cartão de largura inteira; dois ou mais viram uma grade de 2 por linha no computador e 1 por linha no celular. Ao salvar, todos precisam ser visíveis a todos (senão 422 em `blocks[i]`); no envio, o que deixou de ser visível some e o bloco sem nenhum item some inteiro. Lista inválida (vazia, mais de 6, repetida, id malformado) devolve 422 em `blocks[i].productIds`. Vale igual para `eventIds` e `courseIds`. |
block.courseIdfacoltativo | string (uuid) | Em `course`: forma antiga, de um curso só (equivale a `courseIds` com um item). Na resposta, espelha o primeiro de `courseIds`. |
block.eventIdfacoltativo | string (uuid) | Em `event`: forma antiga, de um evento só (equivale a `eventIds` com um item). Na resposta, espelha o primeiro de `eventIds`. |
block.productIdfacoltativo | string (uuid) | Em `product`: forma antiga, de um produto só (equivale a `productIds` com um item). Se `productIds` vier junto, vale a lista. Na resposta, espelha o primeiro de `productIds`. |
Risposte
| Codice | Descrizione |
|---|---|
200 | Bloco salvo. |
400 | Requisição inválida — falha de validação. |
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. |
422 | Bloco inválido (as regras da versão inteira). |
423 | F-174: outra pessoa da equipe está editando o que esta gravação mexe (trava de edição). `errors[0].code` é `locked`; `data.locks` lista o que está travado e quem edita (`editor` nulo quando o chat da comunidade está desligado ou há bloqueio no chat entre as duas pessoas: "outra pessoa da equipe"). Tente de novo quando a pessoa sair do bloco (a trava some sozinha 30 s depois do último sinal dela). |
500 | Erro interno do servidor. |
Esempio con curl
curl -X PUT "https://api.memberfy.net/api/emails/<id>/versions/<language>/blocks/<blockId>" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{"block":{"type":"text"}}'