Update Approval Policy

PATCH /base/approval-policies/{id}

Group: Base › Approval Policies · Operation ID: updateApprovalPolicy

Updates the approval policy with the given identifier. Only the fields in the request body change.

The response is empty. Read the stored state back with GET base/approval-policies/:id. Omitting a field leaves it unchanged, at every level: the header's own fields, a line's fields and an approver's fields. Child collections are edited with three arrays, never by re-sending the collection. createLines adds lines, updateLines changes lines matched by id, and deleteLines removes lines by id, taking their approvers with them. The same split applies to exclusionLines and to each line's approvers. A line you do not mention survives. businessObject cannot be changed. A policy for a different document type is a different policy, so create one and delete this. Setting status to 'active', or moving the policy onto entity coverage that another active policy already covers, fails with CONFLICTING_ACTIVE_POLICY. Editing a policy that already overlaps another is allowed, so a tenant that acquired overlapping policies can still correct them. After your operations the policy must still have at least one rule line, and every surviving line at least one approver, otherwise NO_LINES or LINE_WITHOUT_APPROVERS.

Open in the interactive reference

Parameters

Request body

Required, application/json: updateApprovalPolicyInput.

Example:

{
  "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "isAllEntities": true,
  "status": "inActive",
  "startDate": "<startDate>",
  "endDate": "<endDate>",
  "submitterCannotApprove": true,
  "approverCommentEnabled": true,
  "notification": {
    "emailNotification": true,
    "nativeNotification": true,
    "slackNotification": true
  },
  "createLines": [
    {
      "criteria": "<criteria>",
      "operator": "<operator>",
      "value": [
        "<value>"
      ],
      "valueType": "number",
      "step": 0,
      "requireAction": "All",
      "approvers": [
        {
          "approverId": 0,
          "approverType": "employee"
        }
      ]
    }
  ],
  "updateLines": [
    {
      "id": "4e2b7a90-5c31-4d68-9f02-8a1c6b45e7d3",
      "value": [
        "25000"
      ],
      "createApprovers": [
        {
          "approverId": 77,
          "approverType": "employee"
        }
      ],
      "deleteApprovers": [
        "b8c5d2e1-3f47-4a90-8e16-5d2b9c703f8a"
      ]
    }
  ],
  "deleteLines": [
    "<deleteLines>"
  ],
  "createExclusionLines": [
    {
      "criteria": "<criteria>",
      "operator": "<operator>",
      "value": [
        "<value>"
      ],
      "valueType": "number"
    }
  ],
  "updateExclusionLines": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "criteria": "<criteria>",
      "operator": "<operator>",
      "value": [
        "<value>"
      ],
      "valueType": "number"
    }
  ],
  "deleteExclusionLines": [
    "1a3c5e70-9b24-4f18-a06d-7c8e2b41d95f"
  ]
}

Response

200 Success

Response headers

• Idempotency-Replayed — Present and true only when this response replays a previously stored one for the same Idempotency-Key, rather than reflecting a live execution. Absent on a live response - never sent as false.

Errors

Statuses

• 400 — Invalid request or business failure. Codes: NOT_FOUND, MISSING_ENTITY_SCOPE, ENTITY_NOT_FOUND, UNKNOWN_LINE, UNKNOWN_APPROVER, UNKNOWN_EXCLUSION_LINE, NO_LINES, LINE_WITHOUT_APPROVERS, MISSING_LINE_VALUE, INVALID_NUMBER_VALUE, INVALID_COMPOSITE_EXPRESSION, CONFLICTING_ACTIVE_POLICY
• 401 — Missing or invalid access token
• 403 — Not authorized
• 404 — Not found
• 409 — The Idempotency-Key is still being processed by another request.
• 422 — The Idempotency-Key was already used with a different request payload.
• 429 — Too many requests
• 500 — Internal server error