Clients And Patients

Partially update an organization client

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.

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

Path parameters

organization_client_idinteger required

The ID of the organization client

Request body

primary_clinic_idinteger 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

OK

primary_clinic_idinteger required

The ID of the primary clinic that this organization client is associated with.

Changes

No recorded changes to this operation across all 1 revision of this API.