API Reference

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).

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

Contact json object. At least one name or piece of contact information is required

string
enum
Allowed:
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.

date

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

emailAddresses
array of objects
emailAddresses
string

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

faxNumbers
array of objects
faxNumbers
string
enum
Allowed:
string

Optional free-text details for gender

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

The contact's pronouns

tagIds
array of objects

An array of Spruce contact tag ids

tagIds
Headers
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

Updated 7 months ago

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

Updated 7 months ago