Saltar para o conteúdo

Edita uma empresa residente

PATCH/api/resident-companies/{id}

Auth
Exige token
X-CommunityId
X-CommunityId Envie o X-CommunityId da comunidade em que a operação acontece.

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`).

Parâmetros

NomeOndeTipoDescrição
idobrigatóriopathstring (uuid)

Headers

NomeTipoDescrição
X-CommunityIdopcionalstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Corpo da requisição application/json

NomeTipoDescrição
nameopcionalstringmax 120
residenceTypeopcionalPRIVATE_OFFICE | FIXED_DESK | VIRTUAL_OFFICE
monthlyValueopcionalnumber≥ 0
startsAtopcionalstring (date)
endsAtopcionalstring (date)

Respostas

CódigoDescrição
200Empresa atualizada.
400Requisição inválida — falha de validação.
401Token ausente, inválido ou expirado.
403Autenticado, mas sem permissão para esta operação.
404Recurso não encontrado.
500Erro interno do servidor.

Exemplo com curl

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 '{}'