Bulk User Archive
Bulk User Archive
OVERVIEW
Overview
This API is used to archive multiple users in the system.
Since v5.0
HTTP Request
POST /api/2/users/archive
HTTP Request Object
List of user emails or IDs, either in JSON or XML format.
HTTP Headers
| HTTP Request Header | Description | Example |
|---|---|---|
| Authorization | The API Authorisation token. | "Bearer XXXXXXXXXXXXX" |
| Accept |
The format of the expected response.
If no parameter is set, JSON is the default response given. |
"application/xml" |
| Content-Type |
The format of the provided content
If no parameter is set, JSON is the expected content by default. |
"application/json" |
HTTP Response
Success
HTTP response 200 with list of User Summary Objects
(Example below)
Error
Example HTTP Request & Response
POST http://example.com/context/api/2/users/archive
JSON Request
Users listed in the request object can be a list of either emails, User IDs, or a mixture of both.
{
"users": {
"user": {
"user@domain.com",
6,
187
}
}
}
JSON Response
{
"users": {
"totalcount": 3,
"total": 3,
"currentpage": 0,
"users": [
{
"id": 3,
"email": "user@domain.com",
"link": "http://example.com/context/api/2/user/3"
},
{
"id": 6,
"email": "user2@domain.com",
"link": "http://example.com/context/api/2/user/6"
},
{
"id": 187,
"email": "user3@domain.com",
"link": "http://example.com/context/api/2/user/187"
}
]
}
}
Thank you
Your review has been submitted.
Comments
0 Comments