v3

latestSwagger 2.02026-08-067506752.0 MB

approval

Create an approval chain

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

Path parameters

orgIdstring required

Org identifier (either id or slug)

Query parameters

createDefaultStagesboolean

Create default stages

Request body

entityIdstring

entity id

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

entity type

namestring required

human-readable name of approval chain

isPreviewboolean required

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

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

Response

approval chain created

idstring required

globally unique id

orgIdstring required

parent organization id

entityIdstring

entity id

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

entity type

namestring required

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

createIdstring

created by user id

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",
  "entityType": "SCENARIO",
  "name": "Comp Review 06/15/2022",
  "fallbackApproverJobId": "588f7ee98f138b19220041a7",
  "approvalNotifierGroups": [
    {
      "groupId": "588f7ee98f138b19220041a7",
      "userIds": [
        "588f7ee98f138b19220041a7"
      ]
    }
  ],
  "createId": "588f7ee98f138b19220041a7",
  "createBehalfId": "588f7ee98f138b19220041a7",
  "createAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "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"
}