API Reference

Create Contact

post
https://unify.kolla.dev/dental/v1/contacts

Creates a contact in the remote system. A best effort will be made to
map the providing information to the remote system's schema and in some cases some information
may not be able to be mapped. For example, many systems can only accept one phone number of each type
(home, mobile, work) and may not be able to store a phone number of type 'other'.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

A Contact represents a person or entity (such as a patient, employee, or vendor) stored in the Unify Dental API.

string

Resource name of the Contact, in the format contacts/{contact_id}.

string

The unique identifier for this Contact in the upstream source system.

string
enum

The role this Contact plays within the dental practice.

Allowed:
string

The contact's given (first) name.

string

The contact's family (last) name.

string

The name the contact prefers to be called, which may differ from their legal given name.

string

The contact's middle name or initial, if available.

string
enum

The gender identity of the contact.

Allowed:
string

The contact's date of birth, expressed as a string in YYYY-MM-DD format.

string

Free-text notes or comments associated with this contact, such as medical alerts or scheduling preferences.

addresses
array of objects

The list of physical or mailing addresses associated with this contact.

addresses
phone_numbers
array of objects

The list of phone numbers associated with this contact.

phone_numbers
email_addresses
array of objects

The list of email addresses associated with this contact.

email_addresses
string
enum

The current lifecycle state of this contact.

Allowed:
additional_data
object

A map of key-value pairs containing extra data specific to the upstream source system that does not map to standard Contact fields.

preferred_provider
object

A lightweight representation of a dental provider used for embedding in other messages when only basic identifying information is needed, such as on appointments or referrals.

string

The date of the contact's first visit to the practice, expressed as a string in YYYY-MM-DD format.

string

Resource name of the Contact who is financially responsible for this contact's charges (the guarantor).

opt_ins
object

Tracks whether the contact has opted in to receive communications through specific messaging channels.

Responses

Updated over 1 year ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 1 year ago