Skip to content

Remove o domínio próprio

DELETE/api/communities/custom-domain

Auth
Requires a token
API key:
community:delete
X-CommunityId
X-CommunityId Send 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.

Owner e admin (e o SuperAdmin em sessão de suporte). `scope=all` (padrão) tira da hospedagem o domínio ativo e o pendente; a comunidade continua no subdomínio, que volta a ser o endereço principal na hora. `scope=pending` só desiste do pedido em andamento (o ativo fica). 404 `customDomain.notFound` quando não há o que remover.

Parameters

NameInTypeDescription
scopeoptionalqueryall | pending

Headers

NameTypeDescription
If-Unmodified-SinceoptionalstringOpcional: a versão lida (`settingsUpdatedAt` de `GET /api/communities/settings` ou da última gravação (uma versão só para a linha da comunidade: perfil, marca, imagens, diretório, remetentes das automações e domínio)), como data HTTP, se não vier `settingsUpdatedAt` no corpo. Outra gravação depois dela responde 409.
X-CommunityIdoptionalstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Responses

StatusDescription
200O endereço da comunidade depois da remoção.
400Requisição inválida — falha de validação.
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 (`settingsUpdatedAt` no corpo ou `If-Unmodified-Since`); `data.settingsUpdatedAt` é a versão atual: recarregue e repita. Cada gravação avisa os editores abertos (`item.saved`, ver `POST /api/realtime/ticket`).
500Erro interno do servidor.

curl example

curl -X DELETE "https://api.memberfy.net/api/communities/custom-domain" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID"