User APIs

Move bulk users to another domain

OVERVIEW


Move an existing domain from one organisation to another within Collaborate

This API call is used to move a domain to a new organisation object in the system. This in turn will move all users who have an email address associated with that domain to the new organisation.

 

HTTP Request

PUT   /api/5/users/domains/<DOMAIN ID>?orgid=<ORGID>

 

URL Parameters

 

Parameter

Description

DOMAIN ID

The domain ID to be moved

Example: PUT   http://example.com/context/api/5/users/domains/12?orgid=9

HTTP Request Object

XML Request Object

<user>

    <userid>100</userid>

    <userid>101</userid>

</user>

JSON Request Object

 {

        "userid": [

            "100",

            "101"

        ]

    }

 

HTTP Response

 

Success

HTTP response 200

Error

See  API Error messages 

Error messages

 

Summary Ref Code (V4) Ref Code (before V4)

The given domain ID is invalid

263  

A User ID is required

109  

User ID is not in proper format

113  

The following users do not exist within the system

110  

Moving the selected users to 'bidder' will turn the users into bidders. Delete the following files and retry this operation.

334  

The given action cannot be performed on anonymised user(s).

325  

The specified organisation does not exist

100  

The organisation ID does not match with the domain ID

411  

The Organisation ID is required

322  

The Organisation ID is invalid

260  



 

Comments


0 Comments

Last Updated: Jun 09,2023