Update listing

Listings API · listings.update

URL · Fields · Example · Response · Try it

URL and authentication

POST https://YOUR-BACKEND/api/automation/v1/execute

Send Authorization: Bearer <connection key>, Accept: application/json and Content-Type: application/json. Create a connection.

This operation requires write access and CRM permission edit_listing. The gateway invokes PUT /api/v1/app/listing/{id} internally. Use the POST URL above with your automation key, including for read and delete operations.

Request parameters

Fields

location and all four declared location children are required even on update. The request declares assigned_to for assignment. Size becomes required for a non-land type when size or listing_type_id is supplied. New binary uploads are not supported.

Fields below belong inside data. Dot paths describe nested objects; * means each array item. nullable permits null and sometimes validates a supplied field. in: lists allowed values; min: and max: limit the value, length or item count. exists: and exists_in_company: require a valid record ID. Conditional rules such as required_if and required_with refer to other fields in the same payload. Use YYYY-MM-DD for date-only values and timestamps with timezone offsets for follow-ups.

Example request

Replace the example IDs and values with records in your installation. Supply any additional custom fields required by your company.

{
  "operation": "listings.update",
  "parameters": {
    "id": 1
  },
  "data": {
    "location": {
      "address": "Dubai Marina, Dubai",
      "lat": 25.0805,
      "long": 55.1403,
      "place_id": "REPLACE_WITH_REAL_PLACE_ID"
    }
  },
  "idempotency_key": "example-event-12345"
}

Response

Returns the updated listing in data. Use data.id for subsequent requests. Related fields depend on the resource and your permissions.

The gateway preserves the underlying HTTP status and JSON body. Successful requests return HTTP 200. A response may also include localized message fields.

Illustrative response excerpt (additional fields may be returned):

{
  "status": "success",
  "data": {
    "id": 456,
    "title": "Example apartment",
    "status": "draft",
    "listing_purpose": "sell"
  }
}

Errors

Validation failures may return message / errors, or an error string with an optional fields array. The tester shows the actual HTTP status and full body. Read about limits and retries.

Try it

id must be a positive integer record ID.