Delete policy custom field value

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

delete/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

idstring uuid required

Customer ID

policyIdstring uuid required

Policy ID

customFieldIdstring uuid required

Custom field value ID

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

successboolean required

Whether the deletion was successful

messagestring required

Success message

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