Partially update a clinic client

PATCH

ext

clinic-clients

{clinic_client_id}

curl --request PATCH \
  --url https://connect.vetcove.com/ext/v2/clinic-clients/{clinic_client_id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "client_notes": "",
  "email": "jsmith@example.com",
  "first_name": "<string>",
  "last_name": "<string>",
  "metadata": {},
  "phone_number": "<string>",
  "primary_address_id": 123,
  "primary_client_user_id": 123
}
'

import requests

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

payload = {
    "client_notes": "",
    "email": "jsmith@example.com",
    "first_name": "<string>",
    "last_name": "<string>",
    "metadata": {},
    "phone_number": "<string>",
    "primary_address_id": 123,
    "primary_client_user_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({
    client_notes: '',
    email: 'jsmith@example.com',
    first_name: '<string>',
    last_name: '<string>',
    metadata: {},
    phone_number: '<string>',
    primary_address_id: 123,
    primary_client_user_id: 123
  })
};

fetch('https://connect.vetcove.com/ext/v2/clinic-clients/{clinic_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/clinic-clients/{clinic_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([
    'client_notes' => '',
    'email' => 'jsmith@example.com',
    'first_name' => '<string>',
    'last_name' => '<string>',
    'metadata' => [
        
    ],
    'phone_number' => '<string>',
    'primary_address_id' => 123,
    'primary_client_user_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/clinic-clients/{clinic_client_id}/"

	payload := strings.NewReader("{\n  \"client_notes\": \"\",\n  \"email\": \"jsmith@example.com\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"metadata\": {},\n  \"phone_number\": \"<string>\",\n  \"primary_address_id\": 123,\n  \"primary_client_user_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/clinic-clients/{clinic_client_id}/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"client_notes\": \"\",\n  \"email\": \"jsmith@example.com\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"metadata\": {},\n  \"phone_number\": \"<string>\",\n  \"primary_address_id\": 123,\n  \"primary_client_user_id\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://connect.vetcove.com/ext/v2/clinic-clients/{clinic_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  \"client_notes\": \"\",\n  \"email\": \"jsmith@example.com\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"metadata\": {},\n  \"phone_number\": \"<string>\",\n  \"primary_address_id\": 123,\n  \"primary_client_user_id\": 123\n}"

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

{
  "can_be_called": true,
  "client_notes": "<string>",
  "clinic_id": 123,
  "clinic_patients": {
    "data": [
      {
        "allergies": "<string>",
        "birth_day": 16,
        "birth_month": 6,
        "birth_year": 123,
        "clinic_client_id": 123,
        "custom_breed": "<string>",
        "id": 123,
        "image_url": "<string>",
        "is_active": true,
        "is_alive": true,
        "is_altered": true,
        "is_deactivated": true,
        "is_legacy_deactivated": true,
        "is_surrendered": true,
        "name": "<string>",
        "organization_patient_id": 123,
        "pim_id": "<string>",
        "primary_breed": "AFFENPINSCHER",
        "secondary_breeds": [
          "AFFENPINSCHER"
        ],
        "sex": "MALE",
        "species": "CANINE",
        "weight": 123,
        "insurance": {
          "custom_provider_name": "<string>",
          "policy_number": "<string>",
          "provider_id": 123
        }
      }
    ],
    "next_page": "<string>",
    "has_more": false,
    "type": "list"
  },
  "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",
  "metadata": {},
  "modified": "2023-11-07T05:31:56Z",
  "organization_client_id": 123,
  "pim_id": "<string>",
  "primary_client_user_id": 123,
  "sms_preference": "NA",
  "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
}

Authorizations

Authorization

string

header

required

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

Path Parameters

clinic_client_id

integer

required

The ID of the client to fetch

Body

application/json

client_notes

string

default:""

The notes on the client.

string<email> | null

The primary email address for this clinic client account. This is selected from the available contact methods across all ClientUsers. When updating, these communication methods are assumed to belong to the primary clinic client user.

first_name

string

The first name of the primary clinic client user. For clinic clients with multiple clinic client users (has_multiple_users=true), this updates only the primary clinic client user's name.

last_name

string

The last name of the primary clinic client user. For clinic clients with multiple clinic client users (has_multiple_users=true), this updates only the primary clinic client user's name.

metadata

Metadata · object

User-set metadata related to this client.

phone_number

The primary phone number for this clinic client account. This is selected from the available contact methods across all ClientUsers. When updating, these communication methods are assumed to belong to the primary clinic client user.

primary_address_id

integer

The primary address ID of the clinic client.

primary_client_user_id

integer

The ID of the ClientUser to set as the primary user (account owner) for this client. When changed, the Client's first_name and last_name fields will reflect the new primary user's name. The ClientUser must belong to this Client. Note: Changing the primary ClientUser will clear the relationship_kind and custom_relationship fields on all ClientUsers for this Client.

sms_preference

enum<string> | null

The SMS preference of the clinic client.

Available options:

NA,

ALL,

TRANSACTIONAL,

UNSUBSCRIBED

Response

200 - application/json

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.

clinic_patients

ExternalClinicClientDetailPatientSchemaList · object

required

A list of all clinic patients associated with this clinic client.

Show child attributes

created

string<date-time>

required

The datetime this object was created.

deleted

string<date-time> | null

required

The datetime this record was soft deleted.

external_id

string | null

required

The ID from a clinic's legacy PIMS system, if the data was imported from there.

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)

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 | null

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_visit_date

string<date-time> | null

required

The date of the client's most recent appointment or invoice.

metadata

Metadata · object

required

User-set metadata related to this client.

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 | null

required

The organization client ID corresponding to this clinic client.

pim_id

string | null

required

The ID of the clinic client in the clinic's PIMS.

primary_client_user_id

integer | null

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.

sms_preference

enum<string>

required

Client's SMS preference:

NA: Not applicable or unknown.
ALL: Receive all SMS notifications.
TRANSACTIONAL: Only critical transactional notifications (e.g. password reset, onboarding, checkout).
UNSUBSCRIBED: Do not send any SMS messages.

Available options:

NA,

ALL,

TRANSACTIONAL,

UNSUBSCRIBED

string | null

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.

first_name

string | null

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.

last_name

string | null

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.

phone_number

integer | null

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.

primary_address

ExternalAddressSchema · object | null

The primary address of the clinic client.

Show child attributes

primary_payment_method_id

integer | null

The ID of the primary payment method of the clinic client

⌘I

Partially update a clinic client

curl --request PATCH \
  --url https://connect.vetcove.com/ext/v2/clinic-clients/{clinic_client_id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "client_notes": "",
  "email": "jsmith@example.com",
  "first_name": "<string>",
  "last_name": "<string>",
  "metadata": {},
  "phone_number": "<string>",
  "primary_address_id": 123,
  "primary_client_user_id": 123
}
'

import requests

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

payload = {
    "client_notes": "",
    "email": "jsmith@example.com",
    "first_name": "<string>",
    "last_name": "<string>",
    "metadata": {},
    "phone_number": "<string>",
    "primary_address_id": 123,
    "primary_client_user_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({
    client_notes: '',
    email: 'jsmith@example.com',
    first_name: '<string>',
    last_name: '<string>',
    metadata: {},
    phone_number: '<string>',
    primary_address_id: 123,
    primary_client_user_id: 123
  })
};

fetch('https://connect.vetcove.com/ext/v2/clinic-clients/{clinic_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/clinic-clients/{clinic_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([
    'client_notes' => '',
    'email' => 'jsmith@example.com',
    'first_name' => '<string>',
    'last_name' => '<string>',
    'metadata' => [
        
    ],
    'phone_number' => '<string>',
    'primary_address_id' => 123,
    'primary_client_user_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/clinic-clients/{clinic_client_id}/"

	payload := strings.NewReader("{\n  \"client_notes\": \"\",\n  \"email\": \"jsmith@example.com\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"metadata\": {},\n  \"phone_number\": \"<string>\",\n  \"primary_address_id\": 123,\n  \"primary_client_user_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/clinic-clients/{clinic_client_id}/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"client_notes\": \"\",\n  \"email\": \"jsmith@example.com\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"metadata\": {},\n  \"phone_number\": \"<string>\",\n  \"primary_address_id\": 123,\n  \"primary_client_user_id\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://connect.vetcove.com/ext/v2/clinic-clients/{clinic_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  \"client_notes\": \"\",\n  \"email\": \"jsmith@example.com\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"metadata\": {},\n  \"phone_number\": \"<string>\",\n  \"primary_address_id\": 123,\n  \"primary_client_user_id\": 123\n}"

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

{
  "can_be_called": true,
  "client_notes": "<string>",
  "clinic_id": 123,
  "clinic_patients": {
    "data": [
      {
        "allergies": "<string>",
        "birth_day": 16,
        "birth_month": 6,
        "birth_year": 123,
        "clinic_client_id": 123,
        "custom_breed": "<string>",
        "id": 123,
        "image_url": "<string>",
        "is_active": true,
        "is_alive": true,
        "is_altered": true,
        "is_deactivated": true,
        "is_legacy_deactivated": true,
        "is_surrendered": true,
        "name": "<string>",
        "organization_patient_id": 123,
        "pim_id": "<string>",
        "primary_breed": "AFFENPINSCHER",
        "secondary_breeds": [
          "AFFENPINSCHER"
        ],
        "sex": "MALE",
        "species": "CANINE",
        "weight": 123,
        "insurance": {
          "custom_provider_name": "<string>",
          "policy_number": "<string>",
          "provider_id": 123
        }
      }
    ],
    "next_page": "<string>",
    "has_more": false,
    "type": "list"
  },
  "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",
  "metadata": {},
  "modified": "2023-11-07T05:31:56Z",
  "organization_client_id": 123,
  "pim_id": "<string>",
  "primary_client_user_id": 123,
  "sms_preference": "NA",
  "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
}

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 a clinic client

Authorizations

Path Parameters

Body

Response