October 2025 - New error response type for Publish and Update Listing APIs

Changes to the API since September 2025.

New ChecksError response type

A new error response type, ChecksError, has been introduced for the following endpoints:

• POST /listings/{listing_id}/publish (docs)
• PATCH /listings/{listing_id} (docs)

These endpoints may return a ChecksError response if a resource fails one or more required checks. The response includes detailed information about the failed checks and, where possible, suggested corrective actions.

Note: The checks field in the ChecksError response follows the same schema as the Checks Results endpoint.

Example ChecksError response

{
  "errors": [
    {
      "type": "ChecksError",
      "message": "Required checks failed",
      "checks": {
        "errors": [
          {
            "message": "Apartment number must be specified for apartments.\n"
          }
        ],
        "warnings": []
      }
    }
  ],
  "requestId": "fe165e39-416c-4a57-af2a-556b8b067c5d"
}

Recommended actions for broker systems

We recommend broker systems start supporting the new ChecksError response type. This will provide a clearer insight regarding why certain publishing or update operations can fail, and help agents take corrective action more efficiently.