Skip to main content

Update Data Policy

Update the name or description of a data policy via PATCH. Metadata changes never affect resolution runs that already captured a policy snapshot.

Update the metadata of an existing data policy: its name, its description, or both. This endpoint changes policy-level metadata only; the transformation logic lives on the policy's versions and is authored separately. Resolution runs that already captured a policy snapshot are never affected by metadata changes.

This is a PATCH endpoint: include only the properties you want to change and omitted properties keep their current values. Sending an empty body is a no-op that returns the current policy with its fields and rules inlined.

PATCH/v1/data-policies/{id}

Path parameters

id*uuidData policy UUID.

Body parameters

namestringUpdated policy name.
descriptionstringUpdated policy description.

Request body

{
  "name": "Invoice Normalization v2",
  "description": "Updated: added VAT normalization rules"
}

Response

Response fields

idstringData policy UUID.
namestringUpdated policy name.
descriptionstring | nullUpdated policy description.
statusstringPolicy status (unchanged by metadata updates).
created_atstringISO 8601 creation timestamp.
updated_atstringISO 8601 last update timestamp (advanced by this call).
linksobjectURLs to the policy and its subresources.

curl

Response

{
  "id": "p1a2b3c4-e5f6-7890-abcd-ef1234567890",
  "name": "Invoice Normalization v2",
  "description": "Updated: added VAT normalization rules",
  "status": "published",
  "created_at": "2024-10-01T09:00:00.000Z",
  "updated_at": "2024-10-20T08:15:00.000Z",
  "links": {
    "self": "/v1/data-policies/p1a2b3c4-e5f6-7890-abcd-ef1234567890",
    "versions": "/v1/data-policies/p1a2b3c4-e5f6-7890-abcd-ef1234567890/versions",
    "fields": "/v1/data-policies/p1a2b3c4-e5f6-7890-abcd-ef1234567890/fields",
    "rules": "/v1/data-policies/p1a2b3c4-e5f6-7890-abcd-ef1234567890/rules"
  }
}

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.
Renaming a policy is safe at any time: pipelines reference policies by UUID and resolution runs keep their own snapshot, so a rename never changes execution behavior.

Related

Get Data Policy
List Data Policy Versions