Skip to main content

Update Data Policy

Update the name or description of a data policy. Creates a new version. Does not affect in-flight resolution runs that captured a previous snapshot.

Update the metadata of an existing data policy. You can change the name, description, or both. Each update increments the policy version number. Resolution runs that have already captured a policy snapshot are not affected by this change.

To modify the transformation logic (fields and rules), use the dedicated fields and rules endpoints. This endpoint only updates the policy-level metadata. Version increments from metadata changes are tracked separately from version increments caused by field or rule modifications.

PATCH/v1/data-policies/{id}

Response

Response fields

idstringData policy UUID.
namestringUpdated policy name.
descriptionstring | nullUpdated policy description.
versionintegerIncremented version number.
created_atstringISO 8601 creation timestamp.
updated_atstringISO 8601 last update timestamp.

curl

Response

{
  "id": "p1a2b3c4-e5f6-7890-abcd-ef1234567890",
  "name": "Invoice Normalization v2",
  "description": "Updated: added VAT normalization rules",
  "version": 4,
  "created_at": "2024-10-01T09:00:00.000Z",
  "updated_at": "2024-10-20T08:15:00.000Z"
}

Errors

Error responses

400bad_requestInvalid request body.
401unauthorizedMissing or invalid API key.
404not_foundData policy not found or does not belong to your organization.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.