Skip to main content
PATCH
/
v1
/
delegations
/
{id}
Update delegation
curl --request PATCH \
  --url https://staging.api.us.aptlydone.com/decision/v1/delegations/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "status": "DRAFT",
  "isRootDelegation": false,
  "issuerType": "ROOT_AUTHORITY",
  "issuerUserId": "648fa115-52d0-4466-baff-740447a60774",
  "issuerPositionId": "257fa115-52d0-4466-baff-740447a60774",
  "recipientType": "PERSONNEL_IN_POSITION",
  "recipientAutoIssue": false,
  "decisionId": "864fa115-52d0-4466-baff-740447a60774",
  "parentDelegationId": "726fa115-52d0-4466-baff-740447a60774",
  "expirationDate": "2025-12-31T12:00:00Z",
  "isNoExpiration": false,
  "effectiveDate": "2025-01-01T12:00:00Z",
  "delegationPathway": [
    {
      "pathwayTypeName": [
        "Matrix",
        "Direct Line",
        "Functional"
      ],
      "isInvalid": false
    }
  ],
  "delegationRecipients": [
    {
      "recipientUserId": "485fa115-52d0-4466-baff-740447a60774",
      "recipientPositionId": "14f5a115-52d0-4466-baff-740447a60774",
      "isInvalid": false
    }
  ],
  "delegationGroups": [
    {
      "groupId": "105fa115-52d0-4466-baff-740447a60774",
      "tenantGroupTypeId": "105fa115-52d0-4466-baff-740447a60774",
      "isInvalid": false
    }
  ],
  "delegationAuthorities": [
    {
      "authorityTypeId": "105fa115-52d0-4466-baff-740447a60774",
      "authorityTypeOrder": 1,
      "authorityLimit": "Primary",
      "authorityLimitValueType": "Value (currency)",
      "authorityLimitOperator": "<=",
      "authorityLimitValue": "1000000",
      "authorityLimitValueUnit": "$",
      "redelegable": true,
      "redelegationLimitValue": "500000",
      "redelegationLimitValueUnit": "$",
      "isInvalid": false,
      "isLimitOverridden": false
    }
  ],
  "delegationDocuments": [
    {
      "documentId": "105fa115-52d0-4466-baff-740447a60774",
      "isPinned": true
    }
  ],
  "isInvalid": false,
  "invalidFields": [
    "delegationGroups",
    "delegationAuthorities"
  ]
}'
{
  "id": "9f45f94d-20d2-4163-85d9-68f4f699e440",
  "tenantId": "105fa115-52d0-4466-baff-740447a60774",
  "status": "DRAFT",
  "isRootDelegation": false,
  "issuerType": "ROOT_AUTHORITY",
  "issuerUserId": "648fa115-52d0-4466-baff-740447a60774",
  "issuerPositionId": "257fa115-52d0-4466-baff-740447a60774",
  "recipientType": "PERSONNEL_IN_POSITION",
  "recipientAutoIssue": false,
  "decisionId": "864fa115-52d0-4466-baff-740447a60774",
  "parentDelegationId": "726fa115-52d0-4466-baff-740447a60774",
  "issuedDate": "2025-01-01T12:00:00Z",
  "expirationDate": "2025-12-31T12:00:00Z",
  "isNoExpiration": false,
  "effectiveDate": "2025-01-01T12:00:00Z",
  "copiedFrom": "7df90da4-0634-40b9-abf5-6e97a222cfb8",
  "delegationPathway": [],
  "delegationRecipients": [],
  "delegationGroups": [],
  "delegationAuthorities": [],
  "delegationDocuments": [],
  "delegationDisplayId": "12789",
  "link": "/delegations/view/eyJ0ZW5hbnRJZCI6IjEwNWZhMTE1LTUyZDAtNDQ2Ni1iYWZmLTc0MDQ0N2E2MDc3NCIsImRlbGVnYXRpb25JZCI6IjMwOGNiMzMxLWYwMTgtNGJjNS1hMWE3LTQ1MTI4NTU4MTg0MyJ9",
  "delegationId": "9f45f94d-20d2-4163-85d9-68f4f699e440",
  "sourceDecision": {
    "id": "7df90da4-0634-40b9-abf5-6e97a222cfb8",
    "decisionDisplayId": "14623",
    "name": "Long-term Investments",
    "description": "The Long-term Investments authority involves approving strategic investments",
    "guidance": "Investment decisions for long-term, strategic investments...",
    "sectionId": "105fa115-52d0-4466-baff-740447a60774",
    "categoryId": "248fa115-52d0-4466-baff-740447a60774"
  },
  "isInvalid": false,
  "invalidFields": [
    "delegationGroups",
    "delegationAuthorities"
  ],
  "actionIssuerApproval": true,
  "actionDelegationAcceptance": true,
  "actionAuthorityRequest": true,
  "approvalActionExistForUser": true,
  "acceptanceActionExistForUser": true
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Body

application/json
​
status
enum<string>

Delegation status

Available options:
DRAFT
Example:

"DRAFT"

​
isRootDelegation
boolean

Indicates if this is a Root Delegation

Example:

false

​
issuerType
object

Delegation issuer type

Example:

"ROOT_AUTHORITY"

​
issuerUserId
string

Delegation issuer user id

Example:

"648fa115-52d0-4466-baff-740447a60774"

​
issuerPositionId
string

Delegation issuer position id

Example:

"257fa115-52d0-4466-baff-740447a60774"

​
recipientType
object

Delegation recipient type

Example:

"PERSONNEL_IN_POSITION"

​
recipientAutoIssue
boolean

Auto Issue option for Delegation recipient of type PERSONNEL_IN_POSITION

Example:

false

​
decisionId
string

Source decision for the delegation chain

Example:

"864fa115-52d0-4466-baff-740447a60774"

​
parentDelegationId
string

Parent delegation (Only applicable for non root delegations)

Example:

"726fa115-52d0-4466-baff-740447a60774"

​
expirationDate
string

Date on which delegation will be expired

Example:

"2025-12-31T12:00:00Z"

​
isNoExpiration
boolean

Indicates if "No Expiration" option is selected for expirationDate

Example:

false

​
effectiveDate
string

Date from which delegation will be effective

Example:

"2025-01-01T12:00:00Z"

​
delegationPathway
object[]

Delegation Pathway

​
delegationRecipients
object[]

Delegation Recipients

​
delegationGroups
object[]

Delegation Groups

​
delegationAuthorities
object[]

Delegation Authorities

​
delegationDocuments
object[]

Delegation Documents

​
isInvalid
boolean

Indicates if delegation is invalid

Example:

false

​
invalidFields
string[]

Indicates which delegation fields are invalid

Example:
["delegationGroups", "delegationAuthorities"]

Response

200 - application/json

Delegation updated successfully

​
id
string
required

Unique identifier

Example:

"9f45f94d-20d2-4163-85d9-68f4f699e440"

​
tenantId
string
required

Tenant ID

Example:

"105fa115-52d0-4466-baff-740447a60774"

​
issuerType
object
required

Delegation issuer type

Example:

"ROOT_AUTHORITY"

​
recipientType
object
required

Delegation recipient type

Example:

"PERSONNEL_IN_POSITION"

​
decisionId
string
required

Source decision for the delegation chain

Example:

"864fa115-52d0-4466-baff-740447a60774"

​
issuedDate
string<date-time>
required

Date on which delegation was issued

Example:

"2025-01-01T12:00:00Z"

​
effectiveDate
string<date-time>
required

Date from which delegation will be effective

Example:

"2025-01-01T12:00:00Z"

​
delegationDisplayId
string
required

Delegation Display ID

Example:

"12789"

​
link
string
required

Delegation Link

Example:

"/delegations/view/eyJ0ZW5hbnRJZCI6IjEwNWZhMTE1LTUyZDAtNDQ2Ni1iYWZmLTc0MDQ0N2E2MDc3NCIsImRlbGVnYXRpb25JZCI6IjMwOGNiMzMxLWYwMTgtNGJjNS1hMWE3LTQ1MTI4NTU4MTg0MyJ9"

​
status
enum<string>
default:DRAFT

Delegation status

Available options:
DRAFT,
PENDING,
ISSUED,
ACCEPTED,
REJECTED,
SUSPENDED,
REVOKED,
EXPIRED,
ARCHIVED,
DELETED
Example:

"DRAFT"

​
isRootDelegation
boolean
default:false

Indicates if this is a Root Delegation

Example:

false

​
issuerUserId
string

Delegation issuer user id

Example:

"648fa115-52d0-4466-baff-740447a60774"

​
issuerPositionId
string

Delegation issuer position id

Example:

"257fa115-52d0-4466-baff-740447a60774"

​
recipientAutoIssue
boolean
default:false

Auto Issue option for Delegation recipient of type PERSONNEL_IN_POSITION

Example:

false

​
parentDelegationId
string

Parent delegation (Only applicable for non root delegations)

Example:

"726fa115-52d0-4466-baff-740447a60774"

​
expirationDate
string<date-time>

Date on which delegation will be expired

Example:

"2025-12-31T12:00:00Z"

​
isNoExpiration
boolean
default:false

Indicates if "No Expiration" option is selected for expirationDate

Example:

false

​
copiedFrom
string | null

ID of Delegation which was copied to create current delegation

Example:

"7df90da4-0634-40b9-abf5-6e97a222cfb8"

​
delegationPathway
object[]

Delegation Pathway

​
delegationRecipients
object[]

Delegation Recipients

​
delegationGroups
object[]

Delegation Groups

​
delegationAuthorities
object[]

Delegation Authorities

​
delegationDocuments
object[]

Delegation Documents

​
delegationId
string

Unique identifier

Example:

"9f45f94d-20d2-4163-85d9-68f4f699e440"

​
sourceDecision
object

Source Decision

Example:
{
  "id": "7df90da4-0634-40b9-abf5-6e97a222cfb8",
  "decisionDisplayId": "14623",
  "name": "Long-term Investments",
  "description": "The Long-term Investments authority involves approving strategic investments",
  "guidance": "Investment decisions for long-term, strategic investments...",
  "sectionId": "105fa115-52d0-4466-baff-740447a60774",
  "categoryId": "248fa115-52d0-4466-baff-740447a60774"
}
​
isInvalid
boolean

Indicates if delegation is invalid

Example:

false

​
invalidFields
string[]

Indicates which delegation fields are invalid

Example:
["delegationGroups", "delegationAuthorities"]
​
actionIssuerApproval
boolean

Indicates if the delegation Approval action is on/off in settings

Example:

true

​
actionDelegationAcceptance
boolean

Indicates if the delegation Acceptance action is on/off in settings

Example:

true

​
actionAuthorityRequest
boolean

Indicates if the delegation request action is on/off in settings

Example:

true

​
approvalActionExistForUser
boolean

Indicates that delegation Approval active action exist or not for user as assignee

Example:

true

​
acceptanceActionExistForUser
boolean

Indicates that delegation Acceptance active action exist or not for user as assignee

Example:

true