Skip to content

Update a delegation

Settings module

PATCH/delegations/{id}delegations.update

A time-boxed delegation of approvals from one person to another. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

  • Requires the capability me.out_of_office.write.
  • OAuth scopes: me.
  • Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
  • Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.

Path and query parameters

delegations.update: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the delegation.

Request body: DelegationUpdate

delegations.update: DelegationUpdate
FieldTypeRequiredDescription
valid_fromstring (date-time)NoStart.
valid_tostring (date-time)NoEnd.
capability_codestring | nullNoDelegated capability; null delegates every approve-class capability the delegator holds.Constraints: pattern ^[a-z][a-z_]*(\.[a-z][a-z_]*)+$
reasonstringNoWhy the delegation exists.Constraints: length 1 to 2000
{
  "valid_from": "2026-10-08T14:30:00Z",
  "valid_to": "2026-10-08T14:30:00Z",
  "capability_code": "finance.po.approve",
  "reason": "Annual leave, 12 to 26 May."
}

Response 200: Delegation

delegations.update: Delegation
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the delegation.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
valid_fromstring (date-time)YesStart.
valid_tostring (date-time)YesEnd.
delegator_membership_idstring (uuid)YesIdentifier of the member who delegates.
delegate_membership_idstring (uuid)YesIdentifier of the member who acts for the delegator; never the delegator.
capability_codestring | nullYesDelegated capability; null delegates every approve-class capability the delegator holds.Constraints: pattern ^[a-z][a-z_]*(\.[a-z][a-z_]*)+$
reasonstringYesWhy the delegation exists.Constraints: length 1 to 2000
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "valid_from": "2026-10-08T14:30:00Z",
  "valid_to": "2026-10-08T14:30:00Z",
  "delegator_membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "delegate_membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "capability_code": "finance.po.approve",
  "reason": "Annual leave, 12 to 26 May."
}

Code samples

curl -X PATCH "$XOS_BASE_URL/delegations/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -H "Content-Type: application/json" \
  -d '{"valid_from":"2026-10-08T14:30:00Z","valid_to":"2026-10-08T14:30:00Z","capability_code":"finance.po.approve","reason":"Annual leave, 12 to 26 May."}'
const { data, etag } = await xos.delegations.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "valid_from": "2026-10-08T14:30:00Z",
    "valid_to": "2026-10-08T14:30:00Z",
    "capability_code": "finance.po.approve",
    "reason": "Annual leave, 12 to 26 May."
  }, { ifMatch: etag });
response = xos.delegations.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"valid_from": "2026-10-08T14:30:00Z", "valid_to": "2026-10-08T14:30:00Z", "capability_code": "finance.po.approve", "reason": "Annual leave, 12 to 26 May."}, if_match=etag)
xos delegations update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"valid_from":"2026-10-08T14:30:00Z","valid_to":"2026-10-08T14:30:00Z","capability_code":"finance.po.approve","reason":"Annual leave, 12 to 26 May."}' --if-match auto