Encerra uma empresa residente
POST/api/resident-companies/{id}/close
- Auth
- Requires a token
- 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. Grava `closedAt` e a empresa passa a `ended`. Com `removeMembers` (padrão `true`) a equipe sai da empresa: quem entrou na comunidade pelo convite da empresa e ainda tem papel `member` sai da comunidade também (o mesmo efeito de remover o membro); quem já era membro antes, ou foi promovido depois, só perde o vínculo. Com `removeMembers: false` a equipe continua vinculada. Empresa já encerrada: 409.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string (uuid) |
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. |
Request body application/json
| Name | Type | Description |
|---|---|---|
removeMembersoptional | boolean |
Responses
| Status | Description |
|---|---|
200 | Empresa encerrada; `removed` lista quem saiu e se saiu da comunidade. |
401 | Token ausente, inválido ou expirado. |
403 | Autenticado, mas sem permissão para esta operação. |
404 | Recurso não encontrado. |
409 | Conflito com o estado atual do recurso. |
500 | Erro interno do servidor. |
curl example
curl -X POST "https://api.memberfy.net/api/resident-companies/<id>/close" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{}'