Create a contact

post

https://api.sprucehealth.com/v1/contacts

This operation creates a contact within an organization.

Creating a new contact requires at least of the following fields to be populated (givenName, familyName, phoneNumbers, faxNumbers, emailAddresses).

Body Params

category

string

enum

Allowed:

companyName

string

The contact's company. This field can also be used to specify the name of a non-patient contact, such as another healthcare facility.

dateOfBirth

date

The contact's date of birth in the format YYYY-MM-DD.

emailAddresses

array of objects

emailAddresses

familyName

string

The contact's family name (typically last name in US)

faxNumbers

array of objects

faxNumbers

gender

string

enum

Allowed:

genderDetail

string

Optional free-text details for gender

givenName

string

The contact's given name (typically first name in US)

internalMemberIds

array of strings

The ids of the teammates, teams and/or your organization that are members of the contact. Contact Membership must be enabled for the organization for this field to be interacted with.

internalMemberIds

middleName

string

The contact's middle name

organizationContactFields

array of objects

Fields on a contact that are custom to your organization

organizationContactFields

phoneNumbers

array of objects

phoneNumbers

pronouns

string

The contact's pronouns

tagIds

array of objects

An array of Spruce contact tag ids

tagIds

Headers

s-idempotency-key

string

A unique value generated by the client used to recognize subsequent retries of the same request. Idempotency keys can be up to 255 characters long.

Responses

Language

Credentials

Bearer

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201created

400bad request

422duplicate request

500unexpected error