Cadastra uma empresa residente
POST/api/resident-companies
- Auth
- Requires a token
- 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. `endsAt` é opcional e não pode ser anterior a `startsAt`. `monthlyValue` é só registro (a cobrança continua sendo a assinatura que a empresa compra).
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 |
residenceTyperequired | PRIVATE_OFFICE | FIXED_DESK | VIRTUAL_OFFICE | |
monthlyValuerequired | number | ≥ 0 |
startsAtrequired | 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. |
403 | Autenticado, mas sem permissão para esta operação. |
500 | Erro interno do servidor. |
curl example
curl -X POST "https://api.memberfy.net/api/resident-companies" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{"name":"string","residenceType":"PRIVATE_OFFICE","monthlyValue":10,"startsAt":"string"}'