CAcarecycle
Customers.Dependents

Update customer dependent

Change a dependent's details on a customer's record.

patch/v2/customers/{id}/dependents/{dependentId}

Request

  • Base URL
    https://api.carecycle.ai
  • URL
    https://api.carecycle.ai/v2/customers/{id}/dependents/{dependentId}
  • Auth
    API key in header x-api-key

Path parameters

idstring uuid required

Customer ID

dependentIdstring uuid required

Dependent ID

Request body

firstNamestring nullable
lastNamestring nullable
middleNamestring nullable
gender'Male' | 'Female' | 'Non-Binary' | 'Other' | 'Prefer Not to Say' | 'null' nullable
annualIncomeinteger nullable
relationshipType'Spouse' | 'Child' | 'Parent' | 'Sibling' | 'Other' | 'null' nullable
phonestring nullable
emailstring nullable
isCoveredboolean nullable
isActiveboolean nullable
notesstring nullable

Response

PATCH /v2/customers/:id/dependents/:dependentId Positive response

idstring uuid required
createdAtstring date-time nullable required

Dependent creation time. ISO 8601 timestamp

updatedAtstring date-time nullable required

Dependent last update time. ISO 8601 timestamp

customerIdstring uuid required
firstNamestring nullable required
lastNamestring nullable required
middleNamestring nullable required
dateOfBirthstring date nullable required

Dependent date of birth. Canonical format: YYYY-MM-DD

gender'Male' | 'Female' | 'Non-Binary' | 'Other' | 'Prefer Not to Say' | 'null' nullable required
annualIncomeinteger nullable required
relationshipType'Spouse' | 'Child' | 'Parent' | 'Sibling' | 'Other' | 'null' nullable required
phonestring nullable required
emailstring nullable required
isCoveredboolean nullable required
coverageStartDatestring date nullable required

Dependent coverage start date. Canonical format: YYYY-MM-DD

coverageEndDatestring date nullable required

Dependent coverage end date. Canonical format: YYYY-MM-DD

isActiveboolean nullable required
notesstring nullable required

Changes

No recorded changes to this operation across all 2 revisions of this API.