Skip to main content
PUT
Put Policies

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
patient_id
integer
required

Body

application/json
​
patient_dob
string<date>
required

Patient's date of birth

​
patient_first_name
string
required

Patient's first name

Maximum string length: 70
​
patient_last_name
string
required

Patient's last name

Maximum string length: 70
​
address
string | null

Carrier street address

Maximum string length: 200
​
carrier_id
integer | null

Insurance carrier identifier

​
carrier_name
string | null

Name of the insurance carrier

Maximum string length: 200
​
city
string | null

Carrier city

Maximum string length: 50
​
copay
string | null

Copay amount

Maximum string length: 19
Pattern: ^-?\d{1,8}(\.\d{1,10})?$|^$
​
county_code
string | null

Carrier county code

Maximum string length: 10
​
deductible
string | null

Deductible amount

Maximum string length: 19
Pattern: ^-?\d{1,8}(\.\d{1,10})?$|^$
​
end_date
string<date> | null

Policy end date

​
extension
string | null

Carrier phone extension

Maximum string length: 6
​
group_id
string | null

Group identifier

Maximum string length: 50
​
id
integer | null

Policy ID. If provided, updates the existing policy. If omitted, creates a new policy with a generated ID.

​
insured_person_address
string | null

Insured person's street address

Maximum string length: 200
​
insured_person_city
string | null

Insured person's city

Maximum string length: 50
​
insured_person_dob
string<date> | null

Insured person's date of birth

​
insured_person_first_name
string | null

Insured person's first name

Maximum string length: 200
​
insured_person_id
string | null

Insured person's identifier

Maximum string length: 50
​
insured_person_last_name
string | null

Insured person's last name

Maximum string length: 200
​
insured_person_sex_at_birth
string | null

Insured person's sex at birth

Maximum string length: 1
​
insured_person_ssn
string | null

Insured person's SSN

Maximum string length: 11
​
insured_person_state
string | null

Insured person's state code

Maximum string length: 2
​
insured_person_zip
string | null

Insured person's ZIP code

Maximum string length: 10
​
medicare_secondary_code
string | null

Medicare secondary code

Maximum string length: 5
​
member_id
string | null

Member identifier

Maximum string length: 50
​
payment_program
enum<string> | null

Insurance payment program type

Available options:
medicare_part_b,
medicare_advantage,
medicaid,
commercial_hmsa,
commercial_sfhp,
commercial_other,
workers_compensation
​
phone
string | null

Carrier phone number

Maximum string length: 20
​
plan_id
integer | null

Insurance plan identifier

​
plan_name
string | null

Name of the insurance plan

Maximum string length: 200
​
practice_id
integer | null

Practice the policy belongs to. Must be one of the practices your API credentials are authorized for, or the request is rejected. If omitted and id refers to an existing policy, that policy's current practice is preserved; if omitted and id is absent or doesn't match an existing policy (i.e. this creates a new policy), the first practice associated with your credentials is used, as on create. If your credentials are authorized for more than one practice, always specify this field explicitly — which practice is 'first' is not something you control and is not guaranteed to stay the same over time.

​
rank
integer | null

Policy rank (1=primary, 2=secondary, 3=tertiary)

​
relationship_to_insured
enum<string> | null
default:self

Relationship of the patient to the insured person

Available options:
self,
child,
spouse,
other
​
start_date
string<date> | null

Policy start date

​
state
string | null

Carrier state code

Maximum string length: 2
​
status
enum<string> | null

Current status of the policy

Available options:
active,
inactive
​
suite
string | null

Carrier suite/unit number

Maximum string length: 40
​
vendor_company_id
integer | null

For internal use only

​
vendor_external_id
string | null

For internal use only

Maximum string length: 100
​
zip
string | null

Carrier ZIP code

Maximum string length: 10

Response

Successful Response

​
results
PolicyResponse · object[]
required
​
current_page_num
integer | null
​
next_page_url
string | null
​
page_first_item_num
integer | null
​
page_last_item_num
integer | null
​
previous_page_url
string | null
​
total_item_count
integer | null
​
total_page_count
integer | null