Update Branch Portal Config

Partially update an existing Branch Portal Config - only send the fields you want to change.

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

PATCH/branches/api/v1/portal-configs/{id}/

Example Response

{
  "id": 0,
  "site": 0,
  "statistics": 0,
  "created": "2026-09-08T14:40:51.624Z",
  "modified": "2026-09-08T14:40:51.624Z",
  "deleted": "2026-09-08T14:40:51.624Z",
  "uuid": "770bba28-9f80-4d40-9c51-6e022364af91",
  "source_ref": "string",
  "portal": -2147483648,
  "active": false,
  "credentials": "string",
  "reference": "string",
  "last_log": -2147483648,
  "last_message": "string",
  "feed_status": "string",
  "on_portal": false,
  "branch_email_override": "string",
  "branch_mobile_override_option": "string",
  "branch_mobile_override": "string",
  "exclusive_mandate_types": [],
  "enforce_priority": false,
  "exclusive_time_period": 0,
  "branch": 0
}

NameDescription

id

required

integer

id of Record

NameDescription

id

integer

ID

site

integer

Site

statistics

integer

Statistics

created

string

Created

modified

string

Modified

deleted

nullable

string

Deleted

uuid

string

Uuid

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<= 400 characters

Credentials

reference

nullable

string<= 100 characters

Reference

last_log

nullable

integer

Last log

last_message

nullable

string<= 200 characters

Last message

feed_status

nullable

string

Feed status

Choices: pendingwithdrawnsuccessfailed

on_portal

boolean

On portal

branch_email_override

nullable

string<= 200 characters

Branch email override

branch_mobile_override_option

nullable

string

Branch mobile override option

Choices: BlankSpecific Number

branch_mobile_override

nullable

string<= 40 characters

Branch mobile override

exclusive_mandate_types

nullable

array of strings

Exclusive mandate types

Choices: [ 1,2,3...2147483648 ]

enforce_priority

boolean

Enforce priority

exclusive_time_period

nullable

integer

Exclusive time period

Choices: 1257

branch

nullable

integer

Branch

Responses

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