Skip to main content
PUT
Update Insurance Company

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

id
integer<int64>
required

Body

application/json
carrier
string
required
Maximum string length: 200
practice
integer<int64>
required
address
string
Maximum string length: 200
aliases
string | null

A string used to create alternate terms that will come up in search results (for example "BC" for Blue Cross).

Maximum string length: 300
city
string
Maximum string length: 50
eligibility_payer_id
string | null
Maximum string length: 200
extension
string | null
Maximum string length: 6
external_vendor_id
string | null

The ID used by a vendor to represent the carrier in their system.

Maximum string length: 200
insurance_type
enum<string> | null

An enumerator representing the type of insurance the carrier offers.

Available options:
Capitated,
Commercial,
Managed Medicaid,
Medicaid,
Medicare,
Medicare Advantage,
Medicare Supplement,
Self Pay,
Workers Compensation/Third Party Liability,
None
is_credentialed
boolean | null

Whether or not the practice has credentials to submit claims to the carrier.

is_enrolled
boolean | null
payer_id
string | null

The Payer ID of the insurance carrier.

Maximum string length: 200
phone
string | null
Maximum string length: 20
state
string
Maximum string length: 2
suite
string | null
Maximum string length: 40
zip
string
Maximum string length: 10

Response

200 - application/json
carrier
string
required
Maximum string length: 200
practice
integer<int64>
required
address
string
Maximum string length: 200
aliases
string | null

A string used to create alternate terms that will come up in search results (for example "BC" for Blue Cross).

Maximum string length: 300
city
string
Maximum string length: 50
created_date
string<date-time> | null
read-only
deleted_date
string<date-time> | null
read-only
eligibility_payer_id
string | null
Maximum string length: 200
extension
string | null
Maximum string length: 6
external_vendor_id
string | null

The ID used by a vendor to represent the carrier in their system.

Maximum string length: 200
id
integer
read-only
insurance_type
enum<string> | null

An enumerator representing the type of insurance the carrier offers.

Available options:
Capitated,
Commercial,
Managed Medicaid,
Medicaid,
Medicare,
Medicare Advantage,
Medicare Supplement,
Self Pay,
Workers Compensation/Third Party Liability,
None
is_credentialed
boolean | null

Whether or not the practice has credentials to submit claims to the carrier.

is_enrolled
boolean | null
patients
integer[]
read-only
payer_id
string | null

The Payer ID of the insurance carrier.

Maximum string length: 200
phone
string | null
Maximum string length: 20
plans
integer[]
read-only
state
string
Maximum string length: 2
suite
string | null
Maximum string length: 40
zip
string
Maximum string length: 10