> ## Documentation Index
> Fetch the complete documentation index at: https://docs.proconvey.co.uk/llms.txt
> Use this file to discover all available pages before exploring further.

# Update client

> Partially updates a client record. Only the fields provided are changed. Supply `address` to set or replace the client's postal address; omit the `address` key entirely to leave the existing address unchanged.



## OpenAPI

````yaml https://v2.proconvey.co.uk/api/v2/doc patch /api/v2/clients/{id}
openapi: 3.1.0
info:
  title: ProConvey Public API
  version: '2.0'
  description: Public API for case management.
servers: []
security: []
tags:
  - name: Cases
    description: Case management operations including creation, retrieval, and data access
  - name: Clients
    description: Client records for the organisation
  - name: Webhooks
    description: >-
      Webhooks available for receiving updates of events on the ProConvey
      platform
  - name: Organisations
    description: Organization management and setup
  - name: System
    description: System and utility endpoints including branches and documentation
paths:
  /api/v2/clients/{id}:
    patch:
      tags:
        - Clients
      summary: Update client
      description: >-
        Partially updates a client record. Only the fields provided are changed.
        Supply `address` to set or replace the client's postal address; omit the
        `address` key entirely to leave the existing address unchanged.
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
            format: uuid
          description: Client ID
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                title:
                  type:
                    - string
                    - 'null'
                  description: Client's title (e.g. Mr, Mrs, Ms, Dr)
                firstName:
                  type: string
                  description: First name
                lastName:
                  type: string
                  description: Last name
                emailAddress:
                  type: string
                  format: email
                  description: Email address
                companyName:
                  type:
                    - string
                    - 'null'
                  description: Company name (if applicable)
                telephoneNumber:
                  type:
                    - string
                    - 'null'
                  description: Phone number in E.164 format
                address:
                  oneOf:
                    - type: object
                      description: >-
                        Postal address. Replaces any existing address when
                        provided.
                      required:
                        - line_1
                        - postcode
                      properties:
                        line_1:
                          type: string
                        line_2:
                          type:
                            - string
                            - 'null'
                        line_3:
                          type:
                            - string
                            - 'null'
                        post_town:
                          type:
                            - string
                            - 'null'
                        county:
                          type:
                            - string
                            - 'null'
                        postcode:
                          type: string
                        uprn:
                          type:
                            - string
                            - 'null'
                    - type: 'null'
      responses:
        '200':
          description: Updated client record
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Client'
        '400':
          description: Validation failed or invalid JSON
        '404':
          description: Client not found or not in this organisation
components:
  schemas:
    Client:
      type: object
      description: A client record
      properties:
        id:
          type: string
          format: uuid
          description: Client ID
        title:
          type:
            - string
            - 'null'
          description: Client's title (e.g. Mr, Mrs, Ms, Dr)
        firstName:
          type: string
          description: First name
        middleName:
          type:
            - string
            - 'null'
          description: Middle name
        lastName:
          type: string
          description: Last name
        emailAddress:
          type: string
          format: email
          description: Email address
        companyName:
          type:
            - string
            - 'null'
          description: Company name (if applicable)
        telephoneNumber:
          type:
            - string
            - 'null'
          description: Primary telephone number in E.164 format
        altTelephoneNumber:
          type:
            - string
            - 'null'
          description: Alternative telephone number in E.164 format
        status:
          type: string
          enum:
            - Active
            - Closed
            - Invited
            - NotInvited
            - SendFailed
          description: Client status
        pronouns:
          type:
            - string
            - 'null'
          description: Client's preferred pronouns
        communicationPreferences:
          oneOf:
            - type: object
              description: Communication channel preferences
              properties:
                email:
                  type: boolean
                phone:
                  type: boolean
                sms:
                  type: boolean
                post:
                  type: boolean
            - type: 'null'
        avatarUrl:
          type:
            - string
            - 'null'
          description: URL of the client's avatar image
        dob:
          type:
            - string
            - 'null'
          description: Date of birth
        nationality:
          type:
            - string
            - 'null'
          description: Nationality
        niNumber:
          type:
            - string
            - 'null'
          description: National Insurance number
        occupation:
          type:
            - string
            - 'null'
          description: Occupation
        address:
          description: Client's postal address
          oneOf:
            - $ref: '#/components/schemas/Address'
            - type: 'null'
      required:
        - id
        - firstName
        - lastName
        - emailAddress
        - status
    Address:
      type: object
      description: Postal address
      properties:
        line_1:
          type: string
        line_2:
          type:
            - string
            - 'null'
        line_3:
          type:
            - string
            - 'null'
        post_town:
          type:
            - string
            - 'null'
        county:
          type:
            - string
            - 'null'
        postcode:
          type: string
        uprn:
          type:
            - string
            - 'null'
      additionalProperties: false

````