Vai al contenuto

Exclui um e-mail que não está em uso

DELETE/api/emails/{id}

Auth
Richiede un token
Chiave API:
reports:delete
X-CommunityId
X-CommunityId Invia 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.

Em uso (disparo ativo, e-mail padrão ligado, workflow ativo): 409 `emails.inUse`, com a lista em `data.usages`.

Parametri

NomeDoveTipoDescrizione
idobbligatoriopathstring (uuid)

Header

NomeTipoDescrizione
X-CommunityIdfacoltativostring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Risposte

CodiceDescrizione
200`{ id, deleted: true }`.
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.
409Conflito com o estado atual do recurso.
500Erro interno do servidor.

Esempio con curl

curl -X DELETE "https://api.memberfy.net/api/emails/<id>" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID"