Set user insurance coverage
Submit or replace the authenticated user's active primary self-coverage record.
SDK method: patient.coverage.set() in TypeScript and Python. patient is the user-scoped client, client.forUser(userId) or client.for_user(user_id).
/coverage/Submit or replace the authenticated user's active primary self-coverage record.
The user is identified by X-Doctronic-User-ID. Send all required coverage fields on
every request. Repeated requests update the same record and leave unrelated coverage
records unchanged. The user must already have first name, last name, date of birth,
and sex on file.
This endpoint stores coverage information. It does not verify eligibility or benefits, discover insurance, return or delete coverage, support secondary policies or dependents, or accept effective dates.
Authorization
HTTPBearer XDoctronicUserID In: header
Doctronic user ID returned as data.id by POST /users/. This value identifies the user in your organization scope; it is not an API token.
In: header
Header Parameters
Unique key for safely retrying this mutation for 24 hours. Reuse the same key only with the same request payload.
length <= 255Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Primary insurance coverage supplied for the authenticated user.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PUT "https://example.com/coverage/" \ -H "Content-Type: application/json" \ -d '{ "payerId": "00590", "payerName": "Example Health Plan", "memberId": "ABC1234567" }'{ "code": "success", "message": "Request successful", "data": null}