---
title: "UpdatePartyNameRequest"
url: "https://developer.pexa.co.uk/apis/workspace-v1-v1/versions/f42817f3-815f-4a74-8ba5-2f83efd8ab42/schemas/UpdatePartyNameRequest"
---

> Full API specification: https://developer.pexa.co.uk/apis/workspace-v1-v1/versions/f42817f3-815f-4a74-8ba5-2f83efd8ab42.md

# UpdatePartyNameRequest

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: Workspace
  version: v1
servers:
  - url: https://api.pexa.co.uk
    description: API Gateway URL
components:
  schemas:
    UpdatePartyNameRequest:
      type: object
      required:
        - partyId
        - type
        - partyDetails
      allOf:
        - type: object
          required:
            - action
          discriminator:
            propertyName: action
            mapping:
              UPDATE_PARTY_NAME: "#/components/schemas/UpdatePartyNameRequest"
              SET_AS_INCOMING_PROPRIETOR: "#/components/schemas/SetAsIncomingProprietorRequest"
              SET_AS_OUTGOING_PROPRIETOR: "#/components/schemas/SetAsOutgoingProprietorRequest"
              UPDATE_PROPRIETOR_NAME: "#/components/schemas/UpdateProprietorNameRequest"
              UPDATE_OUTGOING_PROPRIETOR_NAME: "#/components/schemas/UpdateOutgoingProprietorNameRequest"
          properties:
            action:
              type: string
              description: |
                The type of title reconciliation action to perform.
                Allowed values: [`UPDATE_PARTY_NAME`, `SET_AS_INCOMING_PROPRIETOR`, `SET_AS_OUTGOING_PROPRIETOR`, `UPDATE_PROPRIETOR_NAME`, `UPDATE_OUTGOING_PROPRIETOR_NAME`]

                <details>
                <summary><code>UPDATE_PARTY_NAME</code></summary>

                **Required attributes**
                - `partyId`
                - `type` (`INDIVIDUAL` or `ORGANISATION`)
                - `partyDetails`

                **partyDetails by type**
                - `INDIVIDUAL`: `forenames`, `surname`
                - `ORGANISATION`: `organisationName`, `registrationNumber` (optional)

                Use schema: [`UpdatePartyNameRequest`](../schemas/UpdatePartyNameRequest)
                </details>

                <details>
                <summary><code>SET_AS_INCOMING_PROPRIETOR</code></summary>

                **Required attributes**
                - `partyId`

                Use schema: [`SetAsIncomingProprietorRequest`](../schemas/SetAsIncomingProprietorRequest)
                </details>

                <details>
                <summary><code>SET_AS_OUTGOING_PROPRIETOR</code></summary>

                **Required attributes**
                - `proprietorId`

                Use schema: [`SetAsOutgoingProprietorRequest`](../schemas/SetAsOutgoingProprietorRequest)
                </details>

                <details>
                <summary><code>UPDATE_PROPRIETOR_NAME</code></summary>

                **Required attributes**
                - `proprietorId`
                - `type` (`INDIVIDUAL` or `ORGANISATION`)
                - `proprietorDetails`

                **proprietorDetails by type**
                - `INDIVIDUAL`: `forenames`, `surname`
                - `ORGANISATION`: `organisationName`, `registrationNumber` (optional)

                Use schema: [`UpdateProprietorNameRequest`](../schemas/UpdateProprietorNameRequest)
                </details>

                <details>
                <summary><code>UPDATE_OUTGOING_PROPRIETOR_NAME</code></summary>

                **Required attributes**
                - `proprietorId`
                - `type` (`INDIVIDUAL` or `ORGANISATION`)
                - `proprietorDetails`

                **proprietorDetails by type**
                - `INDIVIDUAL`: `forenames`, `surname`
                - `ORGANISATION`: `organisationName`, `registrationNumber` (optional)

                Use schema: [`UpdateOutgoingProprietorNameRequest`](../schemas/UpdateOutgoingProprietorNameRequest)
                </details>
      properties:
        partyId:
          type: string
          format: uuid
          description: ID of the party to update (required for this action)
          example: 123e4567-e89b-12d3-a456-426614174000
        type:
          type: string
          pattern: ^(INDIVIDUAL|ORGANISATION)$
          example: INDIVIDUAL
          description: |
            Type of party or proprietor.
            Allowed values: [`INDIVIDUAL`, `ORGANISATION`]
        partyDetails:
          type: object
          additionalProperties: false
          description: >
            Party details for name update. Required fields depend on party type:

            - For INDIVIDUAL: forenames (string, required), surname (string,
            required)

            - For ORGANISATION: organisationName (string, required),
            registrationNumber (string, optional)
          properties:
            forenames:
              type: string
              minLength: 1
              maxLength: 100
              description: Forenames of the individual party (required for INDIVIDUAL type
                only)
              example: John
            surname:
              type: string
              minLength: 1
              maxLength: 100
              description: Surname of the individual party (required for INDIVIDUAL type only)
              example: Doe
            organisationName:
              type: string
              minLength: 1
              maxLength: 200
              description: Name of the organisation (required for ORGANISATION type only)
              example: Pexa Ltd
            registrationNumber:
              type: string
              maxLength: 20
              description: Registration number of the organisation (optional for ORGANISATION
                type)
              example: "12345678"
```