Skip to main content
PATCH
/
v1
/
user
/
bulk-status-update
Update multiple user statuses
curl --request PATCH \
  --url https://staging.api.us.aptlydone.com/auth/v1/user/bulk-status-update \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "userIds": [
    "82df4321-1518-4788-b213-806d73796555"
  ]
}
'
{
  "statusCode": 200,
  "timestamp": "2026-01-12T09:10:12.337Z",
  "message": "Success",
  "data": {
    "total": 10,
    "successful": 8,
    "failed": 2
  }
}

Authorizations

ā€‹
Authorization
string
header
required

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

Body

application/json
ā€‹
userIds
string<uuid>[]
required

Array of user IDs to update

Example:
["82df4321-1518-4788-b213-806d73796555"]
ā€‹
status
enum<string>
required

Status to set for all users

Available options:
ACTIVE,
INACTIVE,
INVITED,
DELETED

Response

200 - application/json

Users status updated successfully

ā€‹
statusCode
number
required

HTTP Status code

Example:

200

ā€‹
timestamp
string
required

Timestamp of the response

Example:

"2026-01-12T09:10:12.337Z"

ā€‹
message
string
required

Response message

Example:

"Success"

ā€‹
data
object
required

Response data