User APIs

Archive User - Bulk

OVERVIEW

 

This API call is used to archive a user within the system.

 

Request URI

DELETE         /api/3/users/<IDCSV>

 

Parameter   Format Description
IDCSV   The IDs of the user to archive. Maximum 50 IDs can be passed.

Example: DELETE   http://example.com/context/api/4/users/102,103,104

 

HTTP response
 

Success
HTTP response 200 with User Summary Object

 

Error
See  API Error messages 

 

Error messages

 

Summary Ref Code (V4) Ref Code (Before V4)
The following users do not exist within the system:  100000 110  
User ID is not in proper format 113  
A User ID is required 109  
The User's ID length cannot exceeds 50 characters 304  

 

NOTE : Bulk user archive will be available in major release after 4.4

 

Comments


0 Comments

Last Updated: Nov 08,2024