Create listing

Listings API · listings.create

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 add_listing. The gateway invokes POST /api/v1/app/listing internally. Use the POST URL above with your automation key, including for read and delete operations.

Request parameters

Fields

New binary uploads are not supported through this gateway. Upload images/documents through the CRM. Creation uses assigned_to_id for assignment. Required size depends on the listing type and installation configuration.

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.create",
  "data": {
    "title": "Example apartment",
    "description": "Synthetic listing for API testing.",
    "status": "draft",
    "listing_purpose": "sell",
    "listing_type_id": 1,
    "size": 1000,
    "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 created 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

An idempotency key of 8–100 characters is required for writes. Reuse it only for an identical retry.