Skip to main content
PATCH
Update Insurance

Path Parameters

orgId
string<uuid>
required

The ID of the organization

insuranceId
string<uuid>
required

The ID of the insurance to update

Body

Fields that can be updated on an existing insurance configuration

type
enum<string>

The type of insurance plan

Available options:
PPO,
HMO,
EPO,
MEDICAID,
MEDICARE
Example:

"PPO"

status
enum<string>

The status of the insurance provider relationship

Available options:
IN_NETWORK,
ACCEPTED,
CAN_FILE,
CONDITIONAL,
NOT_ACCEPTED
Example:

"IN_NETWORK"

notes
string | null

Additional notes about this insurance

Example:

"Premier and PPO plans accepted"

Response

Response returned after updating an insurance

success
enum<boolean>
required
Available options:
true
data
object
required

Represents an organization's insurance provider configuration