CAcarecycle
Customers.Policies.Custom Fields

Update policy custom field value

Change a custom field's value on a policy. The customFieldId is the value ID returned in policies[].customFields[].id by GET /v2/customers/:id.

patch/v2/customers/{id}/policies/{policyId}/custom-fields/{customFieldId}

Request

  • Base URL
    https://api.carecycle.ai
  • URL
    https://api.carecycle.ai/v2/customers/{id}/policies/{policyId}/custom-fields/{customFieldId}
  • Auth
    API key in header x-api-key

Path parameters

idstring uuid required

Customer ID

policyIdstring uuid required

Policy ID

customFieldIdstring uuid required

Custom field value ID

Request body

textValuestring nullable
numberValuestring nullable
booleanValueboolean nullable
dateValuestring date-time nullable

Custom field date-time value. ISO 8601 timestamp

selectValuestring nullable
multiSelectValuestring[] nullable

Response

PATCH /v2/customers/:id/policies/:policyId/custom-fields/:customFieldId Positive response

idstring uuid required
createdAtstring date-time nullable required

Custom field value creation time. ISO 8601 timestamp

updatedAtstring date-time nullable required

Custom field value last update time. ISO 8601 timestamp

fieldDefinitionIdstring uuid required
recordIdstring uuid required
recordType'customers' | 'policies' required
textValuestring nullable required
numberValuestring nullable required
booleanValueboolean nullable required
dateValuestring date-time nullable required

Custom field date-time value. ISO 8601 timestamp

selectValuestring nullable required
multiSelectValuestring[] nullable required

Changes

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