Skip to main content
POST
Create a contact

Authorizations

x-api-key
string
header
required

Org-issued integration API key (service account credential). The plaintext secret is shown once at creation.

Headers

X-Idempotency-Key
string
required

Stable caller-chosen key (max 200 chars) making the mutation safely retryable.

Maximum string length: 200

Query Parameters

organizationId
string<uuid>

Select one organization for this request. Defaults to the key organization. An HQ key may select an active descendant when its active acting attorney has the required HQ and resource permissions. Repeat the same organizationId on related mutations, upload completion, detail requests, and every cursor page. See /authorization.

Body

application/json
kind
enum<string>
required
Available options:
person,
organization
contactType
enum<string> | null
Available options:
medical_provider,
insurance_carrier,
referral_partner,
vendor,
other,
null
namePrefix
string
Required string length: 1 - 50
firstName
string
Required string length: 1 - 200
lastName
string
Required string length: 1 - 200
entityName
string
Required string length: 1 - 300
email
string<email>
Maximum string length: 320
phone
string
Required string length: 1 - 50
fax
string
Required string length: 1 - 50
address
string
Required string length: 1 - 500
city
string
Required string length: 1 - 120
state
string
Required string length: 1 - 50
zipCode
string
Required string length: 1 - 20
notes
string
Maximum string length: 5000
isCommercial
boolean
tags
string[]
Maximum array length: 50
Required string length: 1 - 100

Response

{ success: true, contact }

success
boolean
required
{key}
any