Create a new clinic client user

POST

ext

clinic-client-users

curl --request POST \
  --url https://connect.vetcove.com/ext/v2/clinic-client-users/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "client_id": 123,
  "first_name": "<string>",
  "last_name": "<string>",
  "phone_number": "<string>",
  "custom_relationship": "<string>",
  "email": "jsmith@example.com"
}
'

import requests

url = "https://connect.vetcove.com/ext/v2/clinic-client-users/"

payload = {
    "client_id": 123,
    "first_name": "<string>",
    "last_name": "<string>",
    "phone_number": "<string>",
    "custom_relationship": "<string>",
    "email": "jsmith@example.com"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    client_id: 123,
    first_name: '<string>',
    last_name: '<string>',
    phone_number: '<string>',
    custom_relationship: '<string>',
    email: 'jsmith@example.com'
  })
};

fetch('https://connect.vetcove.com/ext/v2/clinic-client-users/', 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-client-users/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'client_id' => 123,
    'first_name' => '<string>',
    'last_name' => '<string>',
    'phone_number' => '<string>',
    'custom_relationship' => '<string>',
    'email' => 'jsmith@example.com'
  ]),
  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-client-users/"

	payload := strings.NewReader("{\n  \"client_id\": 123,\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"phone_number\": \"<string>\",\n  \"custom_relationship\": \"<string>\",\n  \"email\": \"jsmith@example.com\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://connect.vetcove.com/ext/v2/clinic-client-users/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"client_id\": 123,\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"phone_number\": \"<string>\",\n  \"custom_relationship\": \"<string>\",\n  \"email\": \"jsmith@example.com\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://connect.vetcove.com/ext/v2/clinic-client-users/")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"client_id\": 123,\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"phone_number\": \"<string>\",\n  \"custom_relationship\": \"<string>\",\n  \"email\": \"jsmith@example.com\"\n}"

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

{
  "clinic_client_id": 123,
  "created": "2023-11-07T05:31:56Z",
  "deleted": "2023-11-07T05:31:56Z",
  "id": 123,
  "is_deleted": true,
  "modified": "2023-11-07T05:31:56Z",
  "custom_relationship": "<string>",
  "email": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "phone_number": 123,
  "relationship_kind": "SPOUSE"
}

Authorizations

Authorization

string

header

required

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

Body

application/json

Schema for creating a new ClientUser

client_id

integer

required

The ID of the clinic client to add this clinic client user to.

first_name

string

required

The first name of the clinic client user.

Required string length: 1 - 30

last_name

string

required

The last name of the clinic client user.

Required string length: 1 - 30

phone_number

required

The phone number of the clinic client user. Must be exactly 10 digits.

custom_relationship

string | null

A custom relationship description (optional). Should be used when relationship_kind is 'Other'.

Maximum string length: 100

string<email> | null

The email address of the clinic client user (optional).

relationship_kind

The type of relationship this clinic client user has to the clinic client account (optional).

Available options:

SPOUSE,

PARTNER,

PARENT,

CHILD,

SIBLING,

OTHER

Response

201 - application/json

Created

clinic_client_id

integer

required

The ID of the clinic client this clinic client user belongs to

created

string<date-time>

required

The datetime this object was created.

deleted

string<date-time> | null

required

The datetime this record was soft deleted.

integer

required

The ID of the clinic client user

is_deleted

boolean

required

Whether this record is soft deleted or not.

modified

string<date-time>

required

The datetime this object was last modified; changes to related entities will not update this field.

custom_relationship

string | null

A custom relationship description if relationship_kind is set to 'Other'.

string | null

The primary email address of the clinic client user.

first_name

string | null

The first name of the clinic client user.

last_name

string | null

The last name of the clinic client user.

phone_number

integer | null

The primary phone number of the clinic client user.

relationship_kind

The type of relationship this clinic client user has to the clinic client account.

Available options:

SPOUSE,

PARTNER,

PARENT,

CHILD,

SIBLING,

OTHER

⌘I

Create a new clinic client user

curl --request POST \
  --url https://connect.vetcove.com/ext/v2/clinic-client-users/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "client_id": 123,
  "first_name": "<string>",
  "last_name": "<string>",
  "phone_number": "<string>",
  "custom_relationship": "<string>",
  "email": "jsmith@example.com"
}
'

import requests

url = "https://connect.vetcove.com/ext/v2/clinic-client-users/"

payload = {
    "client_id": 123,
    "first_name": "<string>",
    "last_name": "<string>",
    "phone_number": "<string>",
    "custom_relationship": "<string>",
    "email": "jsmith@example.com"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    client_id: 123,
    first_name: '<string>',
    last_name: '<string>',
    phone_number: '<string>',
    custom_relationship: '<string>',
    email: 'jsmith@example.com'
  })
};

fetch('https://connect.vetcove.com/ext/v2/clinic-client-users/', 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-client-users/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'client_id' => 123,
    'first_name' => '<string>',
    'last_name' => '<string>',
    'phone_number' => '<string>',
    'custom_relationship' => '<string>',
    'email' => 'jsmith@example.com'
  ]),
  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-client-users/"

	payload := strings.NewReader("{\n  \"client_id\": 123,\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"phone_number\": \"<string>\",\n  \"custom_relationship\": \"<string>\",\n  \"email\": \"jsmith@example.com\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://connect.vetcove.com/ext/v2/clinic-client-users/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"client_id\": 123,\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"phone_number\": \"<string>\",\n  \"custom_relationship\": \"<string>\",\n  \"email\": \"jsmith@example.com\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://connect.vetcove.com/ext/v2/clinic-client-users/")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"client_id\": 123,\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"phone_number\": \"<string>\",\n  \"custom_relationship\": \"<string>\",\n  \"email\": \"jsmith@example.com\"\n}"

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

{
  "clinic_client_id": 123,
  "created": "2023-11-07T05:31:56Z",
  "deleted": "2023-11-07T05:31:56Z",
  "id": 123,
  "is_deleted": true,
  "modified": "2023-11-07T05:31:56Z",
  "custom_relationship": "<string>",
  "email": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "phone_number": 123,
  "relationship_kind": "SPOUSE"
}

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

Create a new clinic client user

Authorizations

Body

Response