VEvetcove
Clients And Patients

Create a clinic client

Creates a new clinic client with the given information and, optionally, associated clinic patients.

A clinic client represents a pet parent (pet owner) at a specific clinic location. Each clinic client belongs to exactly one clinic and can be associated with one or more clinic patients (pets). If the same person visits multiple clinics within the same organization, they will have a separate clinic client record at each location, linked by a shared organization client ID.

post/ext/v2/clinic-clients/

Request

  • Base URL
    https://connect.vetcove.com
  • URL
    https://connect.vetcove.com/ext/v2/clinic-clients/
  • Auth
    HTTP bearer

Request body

client_notesstring

The notes on the client.

clinic_idinteger required

The ID of the clinic which this clinic client belongs to.

emailstring email

The email address of the clinic client.

first_namestring required

The first name of the clinic client.

last_namestring required

The last name of the clinic client.

metadataobject nullable

User-set metadata related to this client.

pim_idstring

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

Response

Created

can_be_calledboolean required

Whether the clinic can call the client.

client_notesstring required

The notes on the client.

clinic_idinteger required

The ID of the clinic this client belongs to.

createdstring date-time required

The datetime this object was created.

deletedstring date-time nullable required

The datetime this record was soft deleted.

emailstring 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_idstring nullable required

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

first_namestring 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_usersboolean 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_clinicboolean required

Whether there are unread inbound messages from the client (for clinic's perspective)

idinteger required

The ID of the clinic client

is_activeboolean required

Whether the client is active.

is_deletedboolean required

Whether this record is soft deleted or not.

is_email_unsubscribedboolean 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_subscribedboolean required

Whether the client is subscribed to receive info from the clinic.

last_namestring 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_datestring date-time nullable required

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

metadataobject required

User-set metadata related to this client.

modifiedstring date-time required

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

organization_client_idinteger nullable required

The organization client ID corresponding to this clinic client.

phone_numberinteger 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_idstring nullable required

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

primary_client_user_idinteger 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_idinteger nullable

The ID of the primary payment method of the clinic client

sms_preference'NA' | 'ALL' | 'TRANSACTIONAL' | 'UNSUBSCRIBED' required

Changes

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