Cadastra uma empresa
POST/api/companies
- Auth
- Requires a token
- API key:
- companies:write
- 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. Só `name` é obrigatório. O bloco de coworking (`residenceType`, `startsAt`, `endsAt`) é todo opcional: preencher qualquer um liga o bloco; `coworking: false` com algum deles preenchido é 400. A empresa é assinante; `offerProductIds` são os planos e produtos (só `digital`) que o admin da empresa contrata em "Minha empresa › Contratar" (`purchaseLink` na resposta) e `billing` são os dados de cobrança (razão social, CNPJ validado, e-mail). `planProductId`, `productId` e `monthlyValue` (forma da 1A) não são mais lidos. Produto de outra comunidade é 404. `endsAt` não pode ser anterior a `startsAt`.
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 |
|---|---|---|
namerequired | string | max 120 |
coworkingoptional | boolean | Liga ou desliga o bloco de coworking. Omitido, fica ligado se algum campo do bloco vier preenchido. |
parcelNoticeAdminsOnlyoptional | boolean | Aviso de encomenda só para os admins da empresa. Padrão `false`. |
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) |
Responses
| Status | Description |
|---|---|
201 | Empresa cadastrada. |
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 | Plano ou produto não encontrado nesta comunidade. |
500 | Erro interno do servidor. |
curl example
curl -X POST "https://api.memberfy.net/api/companies" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{"name":"string"}'