User APIs

Archive User

OVERVIEW


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

 

Request URI

DELETE         /api/3/users/<ID>

 

Parameter   Format Description
ID   The ID of the user to archive

Example: DELETE   http://example.com/context/api/3/users/102

 

HTTP response
 

Success
HTTP response 200 with user summary object

 

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

 

Comments


0 Comments

Last Updated: Nov 08,2024