Edita uma empresa
PATCH/api/companies/{id}
- Auth
- Token erforderlich
- API-Schlüssel:
- companies:write
- X-CommunityId
X-CommunityIdSende die X-CommunityId der Community, in der die Operation stattfindet.
Owner e admin. Só os campos enviados mudam; `null` limpa um campo do bloco (`endsAt: null` remove a data de saída). Preencher um campo do bloco liga o coworking; `coworking: false` desliga e limpa o bloco inteiro (com algum campo do bloco preenchido junto é 400). `offerProductIds` substitui a lista de ofertas (só produtos `digital`; curso, evento, físico e download dão 400) e `billing { legalName, taxId, email }` grava os dados de cobrança (CNPJ inválido é 400, param `billing.taxId`). `planProductId`, `productId` e `monthlyValue` (forma da 1A) não são mais lidos; `coworking: false` sem `offerProductIds` também limpa as ofertas. Uma `endsAt` no passado deixa a empresa `ended` (sem mexer na equipe; para remover a equipe use `POST /api/companies/{id}/close`). `parcelNoticeAdminsOnly` limita o aviso de encomenda aos admins da empresa.
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 |
coworkingoptional | boolean | |
parcelNoticeAdminsOnlyoptional | boolean | Aviso e lembrete de encomenda só para os admins da empresa (`true`) ou para todo funcionário atual com acesso ao space (`false`). Só owner e admin; o admin da empresa não muda. Não booleano: 400. |
residenceTypeoptional | PRIVATE_OFFICE | FIXED_DESK | VIRTUAL_OFFICE | null | |
offerProductIdsoptional | string (uuid)[] | Planos e produtos que a empresa pode contratar (o `ProductMultiPicker`), na ordem escolhida; a lista enviada substitui a anterior e `[]` ou `null` limpa. Só produtos `digital` desta comunidade (opções de plano e adicionais): curso, evento, físico e download dão 400; produto de outra comunidade, 404. |
billingoptional | object | Dados de cobrança da empresa; cada campo é opcional e `null` limpa. `billing` igual a `null` limpa os três. |
billing.legalNameoptional | string | Razão social. · max 160 |
billing.taxIdoptional | string | CNPJ (com ou sem máscara; validado pelos dígitos verificadores e guardado só com os dígitos). |
billing.emailoptional | string (email) | E-mail que recebe as mensagens de cobrança. |
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; 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. |
500 | Erro interno do servidor. |
curl-Beispiel
curl -X PATCH "https://api.memberfy.net/api/companies/<id>" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{}'