v1

latestOpenAPI 3.0.32026-07-2632131.4 MB

Listing external links

Create external link

Adds a new link to the property. url must include protocol (e.g. https://). name is the label shown to users (e.g. "House manual"). The new link is appended to the end; use PUT :propertyId/order to change order.

post/properties-api/listing-settings/external-links/{propertyId}

Path parameters

propertyIdstring required

Example:507f1f77bcf86cd799439011

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

Request body

urlstring uri required

Full URL opened when the user clicks the link. Must include protocol (e.g. https://).

namestring required

Label shown for the link (e.g. "House manual", "Check-in guide"). Required; 1–500 characters.

Example request

{
  "url": "https://example.com",
  "name": "My Website"
}

Response

The created link with assigned id. Use this id for update (PUT), delete (DELETE), or reorder (PUT 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"
}