Sign in

v3

latestSwagger 2.02026-08-067506752.0 MB
approval

Create an approval request

post/v1/org/{orgId}/approval-chain/{approvalChainId}/request

Path parameters

orgIdstring required

Org identifier (either id or slug)

approvalChainIdstring required

Approval chain id

Query parameters

dryRunboolean

Dry run without creating real request

previewJobIdstring

preview-as job id

Request body

entityIdstring required

Example request

{
  "entityId": "588f7ee98f138b19220041a7"
}

Response

approval request created

idstring required

globally unique id

orgIdstring required

parent organization id

entityIdstring required

entity id

entityType'COMP_REVIEW' | 'SCENARIO' | 'TIMEOFF' required

entity type

compReviewIdstring

comp review id

approvalChainIdstring required

parent approval chain id

createIdstring

the user who requested the approval

createBehalfIdstring

created on behalf of user id

createAtstring

created timestamp

updateIdstring

last updated by user id

updateBehalfIdstring

last updated on behalf of user id

updateAtstring

last updated timestamp

deleteIdstring

deleted by user id

deleteBehalfIdstring

deleted on behalf of user id

deleteAtstring

deleted timestamp

Example response

{
  "id": "588f7ee98f138b19220041a7",
  "orgId": "588f7ee98f138b19220041a7",
  "entityId": "588f7ee98f138b19220041a7",
  "compReviewId": "588f7ee98f138b19220041a7",
  "approvalChainId": "588f7ee98f138b19220041a7",
  "createId": "588f7ee98f138b19220041a7",
  "createBehalfId": "588f7ee98f138b19220041a7",
  "createAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "stageOverrides": [
    {
      "stageOverrideId": "588f7ee98f138b19220041a7",
      "approvalChainStageId": "588f7ee98f138b19220041a7",
      "groups": [
        {
          "groupId": "588f7ee98f138b19220041a7",
          "approvers": [
            {
              "jobId": "588f7ee98f138b19220041a7",
              "commentId": "588f7ee98f138b19220041a7",
              "reassignCommentId": "588f7ee98f138b19220041a7",
              "fallbackFor": "588f7ee98f138b19220041a7",
              "actedByJobId": "588f7ee98f138b19220041a7"
            }
          ]
        }
      ]
    }
  ],
  "createAt": "2017-01-24T13:57:52Z",
  "updateId": "588f7ee98f138b19220041a7",
  "updateBehalfId": "588f7ee98f138b19220041a7",
  "updateAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "updateAt": "2017-01-24T13:57:52Z",
  "deleteId": "588f7ee98f138b19220041a7",
  "deleteBehalfId": "588f7ee98f138b19220041a7",
  "deleteAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "deleteAt": "2017-01-24T13:57:52Z"
}