---
title: "SetAsOutgoingProprietorRequest"
url: "https://developer.pexa.co.uk/apis/workspace-v1-v1/versions/32819e5a-6411-493b-abe8-00b7c7ca6c77/schemas/SetAsOutgoingProprietorRequest"
---

> Full API specification: https://developer.pexa.co.uk/apis/workspace-v1-v1/versions/32819e5a-6411-493b-abe8-00b7c7ca6c77.md

# SetAsOutgoingProprietorRequest

Request to mark an unmatched proprietor as outgoing. Only requires proprietorId - the titleStatus will be set to OUTGOING. The response will include proprietor details from the Lodgement domain.

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: Workspace
  version: v1.3.0
servers:
  - url: https://api.pexa.co.uk
    description: API Gateway URL
components:
  schemas:
    SetAsOutgoingProprietorRequest:
      type: object
      description: |
        Request to mark an unmatched proprietor as outgoing.
        Only requires proprietorId - the titleStatus will be set to OUTGOING.
        The response will include proprietor details from the Lodgement domain.
      required:
        - proprietorId
      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:
        proprietorId:
          type: string
          format: uuid
          description: ID of the unmatched proprietor to mark as outgoing (required for
            this action)
          example: 987e6543-e21b-98c7-b654-321098765432
```