---
title: "Partially update an organization client"
method: PATCH
path: "/ext/v2/organization-clients/{organization_client_id}/"
tags: ["Clients And Patients"]
---

# Partially update an organization client

`PATCH /ext/v2/organization-clients/{organization_client_id}/`

## Request

- Base URL: `https://connect.vetcove.com`
- URL: `https://connect.vetcove.com/ext/v2/organization-clients/{organization_client_id}/`
- Auth: HTTP bearer

This endpoint is available to Group API Keys only.

Partially updates an organization client. Only fields included in the request body will be updated; omitted fields are left unchanged.

Setting a primary clinic makes that clinic the source of truth for this person's client and patient records across the organization. Within the request, the client and its patients are copied to that clinic if they aren't there already and it becomes the primary clinic, one organization client per request. Every other clinic's copy is then resynced from it in the background. Returns a 409 if another primary clinic change for this organization client is in progress.

This endpoint must be enabled for your organization. Until it is, requests return a 403. Contact Vetcove to enable it.

An **organization client** is a cross-clinic identity that links together the separate clinic client records that exist when the same person visits multiple clinic locations within the same organization.

## Path parameters

- `organization_client_id` integer, required: The ID of the organization client

## Request body

- OrganizationClientPatchSchema: Schema for the OrganizationClientPatchExternalAPIController request body
  - `primary_clinic_id` integer, nullable: The ID of the clinic to make this organization client's primary clinic. The clinic must be an eligible clinic in the current primary clinic's active clinic network.

## Response `200`

OK

- ExternalOrganizationClientDetailSchema
  - `clinic_clients` ExternalClinicClientSchemaList, required
    - `data` ExternalClinicClientSchema[], required: A single page of data contained within this list.
      - `can_be_called` boolean, required: Whether the clinic can call the client.
      - `client_notes` string, required: The notes on the client.
      - `clinic_id` integer, required: The ID of the clinic this client belongs to.
      - `created` string, date-time, required: The datetime this object was created.
      - `deleted` string, date-time, nullable, required: The datetime this record was soft deleted.
      - `email` string, nullable: The primary email address for this client account. This is selected from the available contact methods across all ClientUsers. When updating via the Client update endpoint, changes are applied to the primary ClientUser.
      - `external_id` string, nullable, required: The ID from a clinic's legacy PIMS system, if the data was imported from there.
      - `first_name` string, nullable: The first name of the primary clinic client user. For clinic clients with multiple clinic client users (has_multiple_users=true), this represents only the primary clinic client user's name.
      - `has_multiple_users` boolean, required: Whether this client has multiple users (co-owners) associated with it. The first_name and last_name fields on this Client represent the primary ClientUser only. Use the /clinic-client-users/ endpoints to view and manage all ClientUsers for this Client.
      - `has_unread_messages_for_clinic` boolean, required: Whether there are unread inbound messages from the client (for clinic's perspective)
      - `id` integer, required: The ID of the clinic client
      - `is_active` boolean, required: Whether the client is active.
      - `is_deleted` boolean, required: Whether this record is soft deleted or not.
      - `is_email_unsubscribed` boolean, nullable, required: Whether the client has unsubscribed from marketing emails, if they have an email on file. A null value indicates they do not have an email on file.
      - `is_subscribed` boolean, required: Whether the client is subscribed to receive info from the clinic.
      - `last_name` string, nullable: The last name of the primary clinic client user. For clinic clients with multiple clinic client users (has_multiple_users=true), this represents only the primary clinic client user's name.
      - `last_visit_date` string, date-time, nullable, required: The date of the client's most recent appointment or invoice.
      - `modified` string, date-time, required: The datetime this object was last modified; changes to related entities will not update this field.
      - `organization_client_id` integer, nullable, required: The organization client ID corresponding to this clinic client.
      - `phone_number` integer, nullable: The primary phone number for this client account. This is selected from the available contact methods across all ClientUsers. When updating via the Client update endpoint, changes are applied to the primary ClientUser.
      - `pim_id` string, nullable, required: The ID of the clinic client in the clinic's PIMS.
      - `primary_address` ExternalAddressSchema
        - `address_one` string, required: The first line of the address.
        - `address_two` string: The second line of the address.
        - `city` string, required: The city of the address.
        - `country` 'CA' | 'US' | 'AS' | 'GU' | 'MP' | 'PR' | 'VI'
        - `county` string: The county of the address.
        - `id` integer, required: The ID of the address.
        - `name` string: The name of the address.
        - `phone_number` integer, nullable: The phone number of the address.
        - `state` string, required: The 2-letter code of the state/province/region of the address. Legacy data could deviate from the 2-letter code convention.
        - `zipcode` string, required: The zip code/postal code of the address.
      - `primary_client_user_id` integer, nullable, required: The ID of the primary ClientUser (account owner) for this client. This is the 'main' owner whose name is reflected in the Client's `first_name` and `last_name` fields.
      - `primary_payment_method_id` integer, nullable: The ID of the primary payment method of the clinic client
    - `has_more` boolean: Whether there are more pages or data in this list.
    - `next_page` string, required: A URL linking to the next page of this list.
    - `type` string: Type of this object. Always `list`.
  - `primary_clinic_id` integer, required: The ID of the primary clinic that this organization client is associated with.

---

[API](https://skmtc.dev/vetcove/apis/ninjaapi.md) - [All operations](https://skmtc.dev/vetcove/apis/ninjaapi/llms.txt) - [OpenAPI document](https://skmtc.dev/vetcove/apis/ninjaapi/revisions/4ceaed956e15?raw)