Params
| Name | Type | Requireness | Default value | Description |
|---|---|---|---|---|
| property_uid | string | required | none | UID of property |
| guidebook_link | string | optional | none | Guidebook link. Must be an http(s) URL. Pass an empty value to unset it. The URL constraint only validates structure and does NOT reject the HTML-breakout characters: its |
| host-label class [\pL\pN\pS\pM-_] accepts the Unicode symbols < > and backtick, and its path/query | ||||
| classes accept the single quote — every one of which breaks out of the unescaped {{guidebook_link}} | ||||
| message sink. The Regex blacklists the same five characters (< > " ' `) the Property-editor | ||||
| validateGuidebookLink() rejects, so both write paths gate the field identically. \x22 is the double | ||||
| quote, written as a hex escape to avoid quoting it inside this annotation string. |
Description
Assign the guidebook link to the specific property by property UID. The stored guidebook link is returned in the response.
Request sample
{
"property_uid": "e3ddcd1a-0e3e-4649-91be-c59d7b56",
"guidebook_link": "https://example.com/guidebook"
}
Response sample
{
"status": 0,
"guidebook_link": "https://example.com/guidebook"
}