Errors

The API's 53 error codes: what each one means and how to fix it.

Every error is application/problem+json (RFC 9457). Branch on code, never on the text: the text follows Accept-Language and may be improved; code does not change. type is the URL of the error page.

{
  "type": "https://imobyflow.com.br/desenvolvedores/erros/invalid-param",
  "title": "Invalid parameter",
  "status": 400,
  "code": "invalid_param",
  "requestId": "8c1f0a4e-2b7d-4c39-9e51-6a0d3f2b1c7e",
  "invalidParams": [
    {
      "name": "address.neighborhoodSlug",
      "reason": "not_in_catalog"
    }
  ]
}

Tap or hover a field to see what it means.

Problem

typestringrequired: URL of this error page, with the cause and the fix.
titlestringrequired: Error name, in the Accept-Language language.
statusintegerrequired: The HTTP status code.
codestringrequired: Stable code — your system should branch on it.
requestIdstringrequired: Request id. Include it when contacting support.
detailstring: Explanation of this case (when available).
invalidParamslist of object: All problems in the request at once — not just the first one.
invalidParams[].namestringrequired: The field, with its path (address.city, phones[0].number).
invalidParams[].reasonstringrequired: The reason, as a code (required, unknown_field, one_of…).

400Bad Request

bad_requestRequest refused
invalid_paramInvalid parameter
invalid_cursorInvalid cursor — restart the listing without it
invalid_bodyInvalid body — send a JSON object
invalid_idempotency_keyInvalid Idempotency-Key (up to 100 visible characters)

401Unauthorized

unauthorizedKey missing, invalid, revoked or expired

403Forbidden

access_not_activeThis account's API is not active
access_deniedAccess denied
IP_NOT_ALLOWEDSource IP not allowed for this key
ACCOUNT_INACTIVEAccount inactive
NOT_REQUESTEDAPI not requested for this account
PENDINGAccess request under review
INFO_REQUESTEDAccess request awaiting information
DENIEDAccess request denied
SUSPENDEDAPI access suspended
REVOKEDAPI access revoked
PLAN_NOT_ELIGIBLEPlan not eligible for the API
SUBSCRIPTION_INACTIVESubscription not active
PILOT_EXPIREDPilot period ended
scope_missingThe key lacks the permission for this route
not_availableResource not available for this account type
captacao_terms_requiredAccepting via the API requires the specific term accepted in the dashboard

404Not Found

route_not_foundRoute not found
not_foundNot found

405Method Not Allowed

method_not_allowedMethod not allowed

409Conflict

idempotency_in_progressA request with this Idempotency-Key is still in progress
concurrent_writeAnother write for this code is in progress — retry
feed_sync_activeAutomatic CRM feed sync is on for this account
feed_not_configuredThe CRM feed link is not set up for this account
plan_limit_reachedPlan limit of active properties reached
property_in_trashProperty is in the trash
external_ref_existsA property with this code already exists
shrink_guardShrink guard: too many deletions in 24 hours
lead_existsA client with this phone or e-mail already exists
lead_linked_to_other_refThe client with this contact already has another CRM code
lead_in_trashClient is in the trash
captacao_not_activeCaptação is not active for this account
offer_unavailableThis owner is no longer available to your account
captacao_insufficient_creditNot enough Captação credit
webhook_limit_reachedAccount webhook limit reached

413Content Too Large

payload_too_largePayload too large

422Unprocessable Content

idempotency_key_reusedIdempotency-Key already used with a different request
invalid_propertyIncomplete or inconsistent property
consent_requiredClient consent not declared
webhook_url_refusedWebhook URL refused
request_refusedThe platform refused the request

429Too Many Requests

rate_limitedPer-second call limit reached
monthly_quota_exceededMonthly quota exhausted

500Internal Server Error

authorizer_failureTemporary failure validating the key
internalInternal error

503Service Unavailable

upstream_busyToo many concurrent requests — retry shortly
upstream_unavailableService temporarily unavailable

504Gateway Timeout

upstream_timeoutThe query took too long — try a smaller page