approval

Update a approval chain

patch/v1/org/{orgId}/approval-chain/{approvalChainId}

Request

  • Base URL: https://localhost
  • URL: https://localhost/v1/org/{orgId}/approval-chain/{approvalChainId}
  • Auth: none declared

Path parameters

orgIdstring required

Org identifier (either id or slug)

approvalChainIdstring required

approval chain id

Request body

namestring

human-readable name of approval chain

isPreviewboolean

isPreview specifies that this is a preview for implementations that use it (e.g. Compensation Reviews)

fallbackApproverJobIdstring

the jobId of the fallback approver

fallbackApproverJobErrorstring

most recent error for fallback approver

Example request

{
  "name": "Comp Review 06/15/2022",
  "fallbackApproverJobId": "588f7ee98f138b19220041a7",
  "approvalNotifierGroups": [
    {
      "groupId": "588f7ee98f138b19220041a7",
      "userIds": [
        "588f7ee98f138b19220041a7"
      ]
    }
  ]
}

Response

snapshot currently building

Changes

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