Organization clients

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

organization-clients

{organization_client_id}

Partially update an organization client

curl --request PATCH \
  --url https://connect.vetcove.com/ext/v2/organization-clients/{organization_client_id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "primary_clinic_id": 123
}
'

import requests

url = "https://connect.vetcove.com/ext/v2/organization-clients/{organization_client_id}/"

payload = { "primary_clinic_id": 123 }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({primary_clinic_id: 123})
};

fetch('https://connect.vetcove.com/ext/v2/organization-clients/{organization_client_id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://connect.vetcove.com/ext/v2/organization-clients/{organization_client_id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'primary_clinic_id' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://connect.vetcove.com/ext/v2/organization-clients/{organization_client_id}/"

	payload := strings.NewReader("{\n  \"primary_clinic_id\": 123\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://connect.vetcove.com/ext/v2/organization-clients/{organization_client_id}/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"primary_clinic_id\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://connect.vetcove.com/ext/v2/organization-clients/{organization_client_id}/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"primary_clinic_id\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "clinic_clients": {
    "data": [
      {
        "can_be_called": true,
        "client_notes": "<string>",
        "clinic_id": 123,
        "created": "2023-11-07T05:31:56Z",
        "deleted": "2023-11-07T05:31:56Z",
        "external_id": "<string>",
        "has_multiple_users": true,
        "has_unread_messages_for_clinic": true,
        "id": 123,
        "is_active": true,
        "is_deleted": true,
        "is_email_unsubscribed": true,
        "is_subscribed": true,
        "last_visit_date": "2023-11-07T05:31:56Z",
        "modified": "2023-11-07T05:31:56Z",
        "organization_client_id": 123,
        "pim_id": "<string>",
        "primary_client_user_id": 123,
        "email": "<string>",
        "first_name": "<string>",
        "last_name": "<string>",
        "phone_number": 123,
        "primary_address": {
          "address_one": "<string>",
          "city": "<string>",
          "id": 123,
          "state": "<string>",
          "zipcode": "<string>",
          "address_two": "",
          "country": "US",
          "county": "",
          "name": "",
          "phone_number": 123
        },
        "primary_payment_method_id": 123
      }
    ],
    "next_page": "<string>",
    "has_more": false,
    "type": "list"
  },
  "primary_clinic_id": 123
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organization_client_id

integer

required

The ID of the organization client

Body

application/json

Schema for the OrganizationClientPatchExternalAPIController request body

primary_clinic_id

integer | null

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 - application/json

clinic_clients

ExternalClinicClientSchemaList · object

required

A list of all clinic clients that are associated with this organization client.

Show child attributes

primary_clinic_id

integer

required

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

⌘I

Partially update an organization client

curl --request PATCH \
  --url https://connect.vetcove.com/ext/v2/organization-clients/{organization_client_id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "primary_clinic_id": 123
}
'

import requests

url = "https://connect.vetcove.com/ext/v2/organization-clients/{organization_client_id}/"

payload = { "primary_clinic_id": 123 }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({primary_clinic_id: 123})
};

fetch('https://connect.vetcove.com/ext/v2/organization-clients/{organization_client_id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://connect.vetcove.com/ext/v2/organization-clients/{organization_client_id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'primary_clinic_id' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://connect.vetcove.com/ext/v2/organization-clients/{organization_client_id}/"

	payload := strings.NewReader("{\n  \"primary_clinic_id\": 123\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://connect.vetcove.com/ext/v2/organization-clients/{organization_client_id}/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"primary_clinic_id\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://connect.vetcove.com/ext/v2/organization-clients/{organization_client_id}/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"primary_clinic_id\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "clinic_clients": {
    "data": [
      {
        "can_be_called": true,
        "client_notes": "<string>",
        "clinic_id": 123,
        "created": "2023-11-07T05:31:56Z",
        "deleted": "2023-11-07T05:31:56Z",
        "external_id": "<string>",
        "has_multiple_users": true,
        "has_unread_messages_for_clinic": true,
        "id": 123,
        "is_active": true,
        "is_deleted": true,
        "is_email_unsubscribed": true,
        "is_subscribed": true,
        "last_visit_date": "2023-11-07T05:31:56Z",
        "modified": "2023-11-07T05:31:56Z",
        "organization_client_id": 123,
        "pim_id": "<string>",
        "primary_client_user_id": 123,
        "email": "<string>",
        "first_name": "<string>",
        "last_name": "<string>",
        "phone_number": 123,
        "primary_address": {
          "address_one": "<string>",
          "city": "<string>",
          "id": 123,
          "state": "<string>",
          "zipcode": "<string>",
          "address_two": "",
          "country": "US",
          "county": "",
          "name": "",
          "phone_number": 123
        },
        "primary_payment_method_id": 123
      }
    ],
    "next_page": "<string>",
    "has_more": false,
    "type": "list"
  },
  "primary_clinic_id": 123
}

Using the API

Developer guides

Accounts

Care plans

Catalog

Checkout links

Clients & patients

Clinics

External Rx

Insurance

Inbox

Invoices

Labs

Onboardings

Orders

Payments

PDFs

Prescriptions

Scheduler

Service pricing

Standard care

Subscriptions

File uploads

Inventory

Forms

Medical records

Partially update an organization client

Authorizations

Path Parameters

Body

Response