Consulta o domínio próprio da comunidade
GET/api/communities/custom-domain
- Auth
- Requires a token
- API key:
- community:read
- 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.
Owner e admin da comunidade do X-CommunityId (e o SuperAdmin em sessão de suporte); moderador, financeiro e membro recebem 403. Um domínio próprio só passa a abrir a comunidade (busca por host) e a ser o endereço principal dos links e e-mails quando fica `ACTIVE`; antes disso ele não responde por ela. Devolve o subdomínio, o endereço principal e o domínio próprio ativo e/ou em configuração, com o registro DNS a criar, o status de cada passo e o erro traduzido.
Headers
| Name | Type | Description |
|---|---|---|
X-CommunityIdoptional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Responses
| Status | Description |
|---|---|
200 | O endereço da comunidade. |
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. |
500 | Erro interno do servidor. |
curl example
curl -X GET "https://api.memberfy.net/api/communities/custom-domain" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID"