Create Website Portal Config

Create a new Website Portal Config.

Optional fields

Any request field marked nullable in the schema may be omitted from the payload entirely - you don't need to send it as null. On a PATCH (partial update), an omitted field is left unchanged; on a POST it's left unset.

HTTP Request

POST/settings/api/v1/portal-configs/

Example Response

{
  "id": 0,
  "site": 0,
  "exclusive_listings": "string",
  "created": "2026-09-08T14:40:52.200Z",
  "modified": "2026-09-08T14:40:52.200Z",
  "deleted": "2026-09-08T14:40:52.200Z",
  "source_ref": "string",
  "portal": -2147483648,
  "active": false,
  "credentials": "string",
  "publish_all_listings": false,
  "default_new_listings": false,
  "override_agent_email": false,
  "override_agent_mobile": false,
  "display": false
}

NameDescription

id

integer

ID

site

integer

Site

exclusive_listings

nullable

string

Exclusive listings

Choices: allowignore

created

string

Created

modified

string

Modified

deleted

nullable

string

Deleted

source_ref

nullable

string<= 100 characters

Source ref - A unique reference to use for linking records back to *your* system. NB: This must be unique across the entire Prop Data system, so it's best to use a consistent prefix unique to your integration to avoid conflicts with other api consumers.

portal

required

integer

Portal

active

boolean

Active

credentials

nullable

string<= 500 characters

Credentials

publish_all_listings

boolean

Publish all listings

default_new_listings

boolean

Default new listings

override_agent_email

boolean

Override agent email

override_agent_mobile

boolean

Override agent mobile

display

boolean

Display

Responses

201
400 Bad request body
403 You do not have permission to perform this action
500 Internal server error
503 This website is not active