User resource

Delete/ Archive User

OVERVIEW

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

Note: 

In the previous version of this API only the AD users could be archived however this updated API endpoint will allow you to archive any Collaborate user in 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

Error Codes

 

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 proper format

 113 113

The User's id length cannot exceeds 50 characters

 N/A 304

 

Comments


0 Comments

Last Updated: Jun 09,2023