Update Portal Listing Field
curl --request PATCH \
--url https://api.conduit.ai/v1/workspaces/{workspace_id}/portal-listings/{listing_id}/fields/{field} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"subunit_id": "<string>",
"value": "<string>"
}
'import requests
url = "https://api.conduit.ai/v1/workspaces/{workspace_id}/portal-listings/{listing_id}/fields/{field}"
payload = {
"subunit_id": "<string>",
"value": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({subunit_id: '<string>', value: '<string>'})
};
fetch('https://api.conduit.ai/v1/workspaces/{workspace_id}/portal-listings/{listing_id}/fields/{field}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.conduit.ai/v1/workspaces/{workspace_id}/portal-listings/{listing_id}/fields/{field}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'subunit_id' => '<string>',
'value' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.conduit.ai/v1/workspaces/{workspace_id}/portal-listings/{listing_id}/fields/{field}"
payload := strings.NewReader("{\n \"subunit_id\": \"<string>\",\n \"value\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.conduit.ai/v1/workspaces/{workspace_id}/portal-listings/{listing_id}/fields/{field}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"subunit_id\": \"<string>\",\n \"value\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.conduit.ai/v1/workspaces/{workspace_id}/portal-listings/{listing_id}/fields/{field}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"subunit_id\": \"<string>\",\n \"value\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"workspace_id": "<string>",
"listing_id": "<string>",
"subunit_id": "<string>",
"fields": [
{
"field": "portalName",
"value": "<string>",
"pms_value": "<string>",
"source": "synced",
"override_mode": "manual",
"document": {
"version": 1,
"type": "doc",
"content": [
{
"type": "paragraph",
"content": [
{
"type": "text",
"text": "<string>",
"marks": [
{
"type": "bold"
}
]
}
]
}
]
},
"conflict": true,
"supports_rich_content": true
}
],
"media": [
{
"storage_id": "<string>",
"url": "<string>"
}
]
}
}{
"error": "Invalid workspace id"
}{
"error": "Invalid workspace id"
}{
"error": "Invalid workspace id"
}{
"error": "Invalid workspace id"
}{
"error": "Invalid workspace id"
}{
"error": "Invalid workspace id"
}Listing fields
Update Portal Listing Field
Set or reset one portal listing field.
PATCH
/
v1
/
workspaces
/
{workspace_id}
/
portal-listings
/
{listing_id}
/
fields
/
{field}
Update Portal Listing Field
curl --request PATCH \
--url https://api.conduit.ai/v1/workspaces/{workspace_id}/portal-listings/{listing_id}/fields/{field} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"subunit_id": "<string>",
"value": "<string>"
}
'import requests
url = "https://api.conduit.ai/v1/workspaces/{workspace_id}/portal-listings/{listing_id}/fields/{field}"
payload = {
"subunit_id": "<string>",
"value": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({subunit_id: '<string>', value: '<string>'})
};
fetch('https://api.conduit.ai/v1/workspaces/{workspace_id}/portal-listings/{listing_id}/fields/{field}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.conduit.ai/v1/workspaces/{workspace_id}/portal-listings/{listing_id}/fields/{field}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'subunit_id' => '<string>',
'value' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.conduit.ai/v1/workspaces/{workspace_id}/portal-listings/{listing_id}/fields/{field}"
payload := strings.NewReader("{\n \"subunit_id\": \"<string>\",\n \"value\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.conduit.ai/v1/workspaces/{workspace_id}/portal-listings/{listing_id}/fields/{field}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"subunit_id\": \"<string>\",\n \"value\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.conduit.ai/v1/workspaces/{workspace_id}/portal-listings/{listing_id}/fields/{field}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"subunit_id\": \"<string>\",\n \"value\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"workspace_id": "<string>",
"listing_id": "<string>",
"subunit_id": "<string>",
"fields": [
{
"field": "portalName",
"value": "<string>",
"pms_value": "<string>",
"source": "synced",
"override_mode": "manual",
"document": {
"version": 1,
"type": "doc",
"content": [
{
"type": "paragraph",
"content": [
{
"type": "text",
"text": "<string>",
"marks": [
{
"type": "bold"
}
]
}
]
}
]
},
"conflict": true,
"supports_rich_content": true
}
],
"media": [
{
"storage_id": "<string>",
"url": "<string>"
}
]
}
}{
"error": "Invalid workspace id"
}{
"error": "Invalid workspace id"
}{
"error": "Invalid workspace id"
}{
"error": "Invalid workspace id"
}{
"error": "Invalid workspace id"
}{
"error": "Invalid workspace id"
}Authorizations
Conduit API token. Use Authorization: Bearer <token>. Read/write endpoints require a token with write access.
Path Parameters
Workspace identifier
Minimum string length:
1PMS listingId from list_listings. The listing must identify one property in this workspace. Ambiguous IDs are rejected.
Minimum string length:
1field
Option 1 · enum<string>Option 2 · enum<string>Option 3 · enum<string>Option 4 · enum<string>Option 5 · enum<string>Option 6 · enum<string>Option 7 · enum<string>Option 8 · enum<string>Option 9 · enum<string>Option 10 · enum<string>Option 11 · enum<string>Option 12 · enum<string>Option 13 · enum<string>Option 14 · enum<string>Option 15 · enum<string>Option 16 · enum<string>Option 17 · enum<string>Option 18 · enum<string>
required
Available options:
portalName Body
application/json
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.
Available options:
set, reset Optional PMS subunit ID belonging to this listing. Omit to edit the property.
Minimum string length:
1Show child attributes
Show child attributes
Response
Update Portal Listing Field
Show child attributes
Show child attributes
Was this page helpful?