Audit Settings

Update

Example request:

{
  "data": {
    "type": "audit_settings",
    "attributes": {
      "audit_relevant_field_ids": [
        "c825720c-fe84-481f-8530-954ac92ae8cf",
        "67ac4d91-1883-47f8-a9a1-f379bbd29cce"
      ],
      "audit_relevant_document_label_ids": [
        "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
      ]
    }
  }
}

This endpoint updates the account’s audit-relevant user fields and/or document labels. Send audit_relevant_field_ids, audit_relevant_document_label_ids, or both. At least one of these attributes is required.

When an ID array is present, it replaces that selection completely: included IDs become audit-relevant, while omitted IDs no longer are. An empty array clears that selection. When an attribute is omitted, the corresponding selection is left unchanged.

The request requires the audit_settings.update right. Every field ID must belong to an active user field in the current account, and every document label ID must belong to an account label in the current account; otherwise, the endpoint returns 404 Not Found without changing the existing selection.

A successful update returns 200 OK with an empty JSON object.

HTTP Request

PUT /api/v1/audit_settings