Errors
Errors use standard HTTP status codes. The table below lists the errors common across the API; resource- and endpoint-specific errors are documented on their respective pages (Create a Lead, List Leads).
| Status | Message | Cause |
|---|---|---|
401 | Unauthorized | Missing or invalid API key |
404 | Not found | {id} does not resolve to a record in your company |
400 | Invalid payload | A field is missing, malformed, or not writable |
400 | Invalid query | A query parameter failed validation |
409 | Duplicate externalId | Another record in the same scope already uses this externalId |
409 | Managed by integration | The record syncs from your PMS and is read-only via the API |
Notes on specific errors
404 Not foundis scoped to your company. Anidthat belongs to another company resolves the same as one that does not exist.409 Duplicate externalIdrespects scope: external IDs are unique per company for properties, and per property for floorplans and units.409 Managed by integrationmeans the record originates from a connected property management system such as Yardi. The integration stays authoritative, so write it through your PMS instead.- The Portfolio API adds delete guards:
409 Property not emptyand409 Floorplan not empty. See Portfolio Overview.
Last updated on