Update multiple positions

PATCH /v1/positions/bulk-status-update

Update multiple positions

cURL

curl --request PATCH \
  --url https://staging.api.us.aptlydone.com/settings/v1/positions/bulk-status-update \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ids": [
    "aefb8f2d-5d02-4f63-b759-7bb6009e9a05, a8d2194f-c991-4c09-ba32-7d81a3a60d83"
  ],
  "status": "ACTIVE"
}
'

200

{
  "statusCode": 200,
  "timestamp": "2026-01-08T06:33:20.711Z",
  "message": "Success",
  "data": [
    {
      "id": "1533d1e1-b367-4b1e-bd45-bec6d1939149",
      "tenantId": "7991d6c1-8488-406e-acf6-f07e7d1399e8",
      "positionId": "10000",
      "positionName": "Senior Developer",
      "isSCIMProvisioned": false,
      "status": "ACTIVE",
      "isDeleted": false,
      "createdOn": "2025-01-13T12:34:59.300Z",
      "updatedOn": "2025-01-13T12:34:59.300Z",
      "groups": [
        {
          "groupName": "Engineering Team",
          "displayName": "Engineering Team Display",
          "groupTypeName": "Organizations",
          "groupId": "9fbe4911-1eae-499e-9190-a447a7134fe7",
          "groupTypeId": "a51e8d10-388f-4042-b8a8-578b7ace6992",
          "parentId": 2,
          "parentName": "Technology Division",
          "createdAt": "2025-01-13T12:34:59.303Z",
          "updatedAt": "2025-01-13T12:34:59.303Z"
        }
      ],
      "delegationsReceived": 1,
      "delegationsIssued": 1,
      "externalId": "EXT-POS-12345",
      "instanceId": "db036aaa-14fe-454a-bc23-a722e4106925"
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Body

application/json

ids · string[] · required

Array of position IDs

Minimum array length: 1

Example:

[
  "aefb8f2d-5d02-4f63-b759-7bb6009e9a05, a8d2194f-c991-4c09-ba32-7d81a3a60d83"
]

status · enum<string> · required

New status to set (ACTIVE or INACTIVE)

Available options: ACTIVE, INACTIVE

Response

200 - application/json

Positions status updated successfully

statusCode · number · required

HTTP Status code

Example:

200

timestamp · string · required

Timestamp of the response

Example:

"2026-01-08T06:33:20.711Z"

message · string · required

Response message

Example:

"Success"

data · object[] · required

Response data

Show child attributes