DELETE
/
v1
/
users
/
archive
/
bulk
curl --request DELETE \
  --url https://api.qobra.co/v1/users/archive/bulk \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "data": [
    {
      "user": "user-1@company.com",
      "end_date": "2023-10"
    },
    {
      "user": "user-2@company.com"
    },
    "..."
  ]
}'
{
  "message": "users archived successfully"
}

​
Behavior

  • Transaction: If one part of the payload is not parsable (or understandable by the system), we raise you an error and we don’t archive anyone from the payload. You have to fix your payload and send it to us again. And if the answer is a success, it means that every user to archive you sent us have been archived successfully
  • Conflict Rule and archive: If you try to archive a user that is managing someone on the given archive period, we raise you an error.
  • Limit: you can’t archive more than 50 users at a time.
  • Error behavior: In case of any error, your user wont be archived

Authorizations

​
X-API-Key
string
header
required

Body

application/json
The body contains the user data necessary to archive a user in Qobra
​
data
object[]
required

Response

200
application/json
Success operation
​
message
string
required

Confirmation message

Was this page helpful?

Raise issue