Encerra uma empresa
POST/api/companies/{id}/close
- Auth
- Requiere token
- Clave de API:
- companies:delete
- X-CommunityId
X-CommunityIdEnvía el X-CommunityId de la comunidad en la que ocurre la operación.
Las descripciones de los endpoints vienen de la especificación de la API y, por ahora, están en portugués. La interfaz alrededor está traducida.
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.
Parámetros
| Nombre | Dónde | Tipo | Descripción |
|---|---|---|---|
idobligatorio | path | string (uuid) |
Headers
| Nombre | Tipo | Descripción |
|---|---|---|
X-CommunityIdopcional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Cuerpo de la solicitud application/json
| Nombre | Tipo | Descripción |
|---|---|---|
removeMembersopcional | boolean |
Respuestas
| Código | Descripción |
|---|---|
200 | Empresa encerrada; `removed` lista quem saiu e se saiu 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. |
404 | Recurso não encontrado. |
409 | Conflito com o estado atual do recurso. |
500 | Erro interno do servidor. |
Ejemplo con curl
curl -X POST "https://api.memberfy.net/api/companies/<id>/close" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{}'