Pular para o conteúdo
memberfy
BR

Renomeia o e-mail ou troca o idioma principal

PATCH/api/emails/{id}

Auth
Exige token
Chave de API:
reports:write
X-CommunityId
X-CommunityId Envie o X-CommunityId da comunidade em que a operação acontece.

O idioma principal precisa ter versão (422). Vivo: os próximos envios dos disparos que o usam mudam (B4); o que já saiu fica no relatório.

Parâmetros

NomeOndeTipoDescrição
idobrigatóriopathstring (uuid)

Headers

NomeTipoDescrição
If-Unmodified-SinceopcionalstringOpcional: a versão lida (`updatedAt` do `GET`), 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.

Corpo da requisição application/json

NomeTipoDescrição
updatedAtopcionalstring (date-time)Opcional: a versão lida (`updatedAt` do `GET`). Diferente da atual responde 409; sem ela grava sem conferir.
nameopcionalstringmax 200
mainLanguageopcionalstring

Respostas

CódigoDescrição
200O e-mail.
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`).
422Campo inválido.
500Erro interno do servidor.

Exemplo com curl

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