Skip to main content
PATCH
Update Portal Listing Field

Authorizations

Authorization
string
header
required

Conduit API token. Use Authorization: Bearer <token>. Read/write endpoints require a token with write access.

Path Parameters

workspace_id
string
required

Workspace identifier

Minimum string length: 1
listing_id
string
required

PMS listingId from list_listings. The listing must identify one property in this workspace. Ambiguous IDs are rejected.

Minimum string length: 1
field
required

Field to edit: portalName (property name shown to guests), address, googleMapsUrl, appleMapsUrl, directions, area (neighborhood description), checkInTime, checkInInstructions, checkOutTime, checkOutInstructions, wifiUsername (wifi network name), wifiPassword, parking, houseRules, houseManual, trashLocation, trashCollection (pickup days), doorCode (door or lock code).

Available options:
portalName

Body

application/json
action
enum<string>
required

set replaces one field with exactly one of value or document. reset removes its override and restores the PMS value, or the inherited property value for a subunit. hide keeps the field off the portal; portalName and address cannot be hidden.

Available options:
set,
reset,
hide
subunit_id
string

Optional PMS subunit ID belonging to this listing. Omit for the property itself.

Minimum string length: 1
value
string

Plain-text value for set. On rich fields, send document instead to keep formatting or images.

document
object

Rich-text value for set. Only for directions, area, checkInInstructions, checkOutInstructions, parking, houseRules, houseManual, trashLocation, and trashCollection. Send the complete document, including every image to keep. An image node takes a registered storageId, or a public https url that Conduit downloads: JPEG, PNG, WebP, GIF, or AVIF up to 10 MB, without redirects. Links can be web, mailto, or tel links.

Response

Update Portal Listing Field

data
object
required