Sign in

v1

latestOpenAPI 3.0.32026-07-2632131.4 MB
Listing external links

Reorder external links

Sets the display order of links. Send linkIds in the order you want (first id = first link). Only the ids you send are moved to the top in that order; any other links for the property stay at the bottom unchanged. All ids must exist for this property; no duplicates. Use GET to obtain current ids.

put/properties-api/listing-settings/external-links/{propertyId}/order

Path parameters

propertyIdstring required
Example:507f1f77bcf86cd799439011

The property (listing) ID. A 24-character hexadecimal string.

Request body

linkIdsstring[] required

Link ids in the order you want them to appear. These move to the top; other links for the property stay at the bottom. All ids must exist for this property; no duplicates. Get ids from GET :propertyId.

Example request

{
  "linkIds": [
    "507f1f77bcf86cd799439011",
    "507f191e810c19729de860ea"
  ]
}

Response

Full list of external links for the property in the new order.

idstring required

Unique id of the link. Use for update (PUT :propertyId/:linkId), delete (DELETE), or reorder (PUT :propertyId/order).

urlstring required

URL of the link (with protocol).

namestring required

Display name shown to users.

Example response

[
  {
    "id": "507f1f77bcf86cd799439011",
    "url": "https://example.com",
    "name": "My Website"
  }
]