Update

Changed on Oct 29, 2026

Updates a Coverage. The path must contain the next version number to prevent race conditions. For example, if the current version of the coverage is n, you will need to send a request to this endpoint with /{id}/n+1 to update the coverage. Updating historic versions is not supported.

put/coverages/v1//{id}/{version}

Request

Base URL
https://pre-api.joincandidhealth.com
URL
https://pre-api.joincandidhealth.com/coverages/v1//{id}/{version}
Auth
HTTP bearer

Path parameters

idstring uuid required

The unique identifier for a Coverage in the database

versionstring required

Request body

status'ACTIVE' | 'CANCELLED' | 'DRAFT' | 'ENTERED_IN_ERROR' required

enum to represent the statuses defined at https://build.fhir.org/valueset-fm-status.html

relationship'SELF' | 'SPOUSE' | 'CHILD' | 'COMMON_LAW_SPOUSE' | 'OTHER' required

patientstring required

The unique identifier for a Patient

verifiedboolean required

A boolean indicating if the coverage has been verified by a user.

orconboolean

ORCON (Originator Controlled) - When set to true, the Candid system will hide this coverage from downstream integrations. Updates made in the Candid UI will unset this flag. Defaults to false.

auto_update_enabledboolean

Default to true. When set to true, the Candid system will automatically update this coverage with the latest eligibility check benefits information. Auto update behavior is also set at the eligibilityConfig org level configuration.

previous_appointment_copaysobject

A map of UniversalServiceIdentifier (MD_Visit, Treatment, Tests, Activity) to copay values in cents. This is used to track copay values for each service type to handle OOP max resets correctly.

Response

Response with status 200

organization_idstring required

The unique identifier for an Organization in the database

deactivatedboolean required

True if the object is deactivated. Deactivated objects are not returned in search results but are returned in all other endpoints including scan.

versioninteger required

The version of the object. Any update to any property of an object object will create a new version.

updated_atstring date-time required

updating_user_idstring required

The unique identifier for a User in the database