Edita uma empresa residente
PATCH/api/resident-companies/{id}
- Auth
- Token erforderlich
- X-CommunityId
X-CommunityIdSende die X-CommunityId der Community, in der die Operation stattfindet.
Die Beschreibungen der Endpoints stammen aus der API-Spezifikation und sind vorerst auf Portugiesisch. Die Oberfläche drumherum ist übersetzt.
Owner e admin. Só os campos enviados mudam; `endsAt: null` tira a data de saída. Uma `endsAt` no passado deixa a empresa `ended` (sem mexer na equipe; para tirar a equipe use `POST /api/resident-companies/{id}/close`).
Parameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
idPflicht | path | string (uuid) |
Header
| Name | Typ | Beschreibung |
|---|---|---|
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 | Typ | Beschreibung |
|---|---|---|
nameoptional | string | max 120 |
residenceTypeoptional | PRIVATE_OFFICE | FIXED_DESK | VIRTUAL_OFFICE | |
monthlyValueoptional | number | ≥ 0 |
startsAtoptional | string (date) | |
endsAtoptional | string (date) |
Antworten
| Status | Beschreibung |
|---|---|
200 | Empresa atualizada. |
400 | Requisição inválida — falha de validação. |
401 | Token ausente, inválido ou expirado. |
403 | Autenticado, mas sem permissão para esta operação. |
404 | Recurso não encontrado. |
500 | Erro interno do servidor. |
curl-Beispiel
curl -X PATCH "https://api.memberfy.net/api/resident-companies/<id>" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{}'