Search
K
workspace v1

UpdateProprietorNameRequest

object
actionstringrequired

The type of title reconciliation action to perform. Possible values are UPDATE_PARTY_NAME, SET_AS_INCOMING_PROPRIETOR, SET_AS_OUTGOING_PROPRIETOR, UPDATE_PROPRIETOR_NAME, UPDATE_OUTGOING_PROPRIETOR_NAME

proprietorIdstring(uuid)required

ID of the proprietor to update (required for this action)

Example:987e6543-e21b-98c7-b654-321098765432

typestringrequired

Type of party or proprietor.
Allowed values: [INDIVIDUAL, ORGANISATION]

Match pattern:^(INDIVIDUAL|ORGANISATION)$

Example:INDIVIDUAL

proprietorDetailsobjectrequired

Proprietor details for name update. Required fields depend on proprietor type:

  • For INDIVIDUAL: forenames (string, required), surname (string, required)
  • For ORGANISATION: organisationName (string, required), registrationNumber (string, optional)
* Additional properties are NOT allowed.
Show Child Parameters
Example

UpdateOutgoingProprietorNameRequest

object

Request to update an OUTGOING role proprietor’s name via orchestrated flow.
This action is for proprietors that have been marked as outgoing (via SET_AS_OUTGOING_PROPRIETOR).
PCS will call getProprietors to find the linked workspace party, then update the party name.

actionstringrequired

The type of title reconciliation action to perform. Possible values are UPDATE_PARTY_NAME, SET_AS_INCOMING_PROPRIETOR, SET_AS_OUTGOING_PROPRIETOR, UPDATE_PROPRIETOR_NAME, UPDATE_OUTGOING_PROPRIETOR_NAME

proprietorIdstring(uuid)required

ID of the outgoing proprietor to update (required for this action)

Example:987e6543-e21b-98c7-b654-321098765432

typestringrequired

Type of party or proprietor.
Allowed values: [INDIVIDUAL, ORGANISATION]

Match pattern:^(INDIVIDUAL|ORGANISATION)$

Example:INDIVIDUAL

proprietorDetailsobjectrequired

Proprietor details for name update. Required fields depend on proprietor type:

  • For INDIVIDUAL: forenames (string, required), surname (string, required)
  • For ORGANISATION: organisationName (string, required), registrationNumber (string, optional)
* Additional properties are NOT allowed.
Show Child Parameters
Example

TitleReconciliationPatchResponse

object

Response for title reconciliation actions

actionstringrequired

The action that was performed

Example

UpdatePartyNameResponse

object
actionstringrequired

The action that was performed

partyIdstring(uuid)required

ID of the party that was updated

typestringrequired

Type of party that was updated

partyDetailsobject

Updated party details (type-specific fields)

Show Child Parameters
Example

SetAsIncomingProprietorResponse

object
actionstringrequired

The action that was performed

partyIdstring(uuid)required

ID of the party that was marked as incoming proprietor

proprietorIdstring(uuid)required

ID of the newly created incoming proprietor in lodgement case

titleStatusstring

Title status of the proprietor (always INCOMING for this action)

Example