Errors · Status 403Forbidden
module_required
This write requires a module the account does not have on
Why it happens
The route writes to the CRM or Rentals, and the account does not have that module on right now (invalidParams[0].value says which: crm or rent). Reading what was already recorded still works.
How to fix
The account owner turns the module on in the dashboard, under Account › Plan. Until then, use the read routes.
Who answers
the API
Routes that return this error
- PUT/v1/properties/{propertyId}/owner— Save the owner
- POST/v1/leads/{leadId}/contacts— Log how the contact went
- POST/v1/leads/{leadId}/next-step— Set the next step
- POST/v1/leads/{leadId}/temperature— Lock the temperature
- POST/v1/leads/{leadId}/lost— Close as lost
- POST/v1/leads/{leadId}/visits— Schedule a visit
- POST/v1/visits/{visitId}/reschedule— Reschedule the visit
- POST/v1/visits/{visitId}/cancel— Cancel the visit
- POST/v1/visits/{visitId}/outcome— Log how the visit went
- POST/v1/leads/{leadId}/proposals— Record an offer
- POST/v1/proposals/{proposalId}/rounds— Record a counteroffer
- POST/v1/proposals/{proposalId}/close— Close the offer
- POST/v1/rent/contracts/{contractId}/tickets— Open a ticket
- PATCH/v1/rent/contracts/{contractId}/tickets/{ticketId}— Update the ticket
- POST/v1/rent/contracts/{contractId}/tickets/{ticketId}/stage— Move the ticket
- POST/v1/rent/contracts/{contractId}/tickets/{ticketId}/cancel— Cancel the ticket
Example
{
"type": "https://imobyflow.com.br/desenvolvedores/erros/module-required",
"title": "This write requires a module the account does not have on",
"status": 403,
"code": "module_required",
"requestId": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e"
}Tap or hover a field to see what it means.