v1

latestOpenAPI 3.0.32026-07-2632131.4 MB

Listing external links

Update external link

Updates URL and/or display name of one link. Include only the fields you want to change (url, name, or both). linkId is from the list (GET) or a create response.

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

Path parameters

propertyIdstring required

Example:507f1f77bcf86cd799439011

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

linkIdstring required

Example:507f191e810c19729de860ea

ID of the external link to update or delete. Use an id from the list (GET) or from a create response. Must be 24 hexadecimal characters.

Request body

urlstring uri

New URL for the link. Omit to leave unchanged. Must include protocol if set.

namestring

New display name. Omit to leave unchanged. 1–500 characters if set.

Example request

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

Response

The updated link (id, url, name).

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"
}