Cadastra uma empresa residente
POST/api/resident-companies
- Auth
- Requiere token
- X-CommunityId
X-CommunityIdEnvía el X-CommunityId de la comunidad en la que ocurre la operación.
Las descripciones de los endpoints vienen de la especificación de la API y, por ahora, están en portugués. La interfaz alrededor está traducida.
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
| Nombre | Tipo | Descripción |
|---|---|---|
X-CommunityIdopcional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Cuerpo de la solicitud application/json
| Nombre | Tipo | Descripción |
|---|---|---|
nameobligatorio | string | max 120 |
residenceTypeobligatorio | PRIVATE_OFFICE | FIXED_DESK | VIRTUAL_OFFICE | |
monthlyValueobligatorio | number | ≥ 0 |
startsAtobligatorio | string (date) | |
endsAtopcional | string (date) |
Respuestas
| Código | Descripción |
|---|---|
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. |
Ejemplo con curl
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"}'