Domain APIs

Move 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

POST   /api/4/domains/<DOMAIN ID>?neworganisation=<NEWORGID>

 

URL Parameters

 

Parameter

Description

DOMAIN ID

The domain ID to be moved

NEWORGID

The ID of the organisation to move the domain to

 

HTTP Response

 

Success

HTTP response 200

Error

See  API Error messages 

Example

POST  http://example.com/context/api/4/domains/12?neworganisation=4

 

Error messages

 

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

The given domain id is invalid

 263 N/A

The Organisation id is invalid (Target Organisation id)

 261 N/A

Please select different organisation

 262 N/A

The domain cannot be moved to a bidder organisation

 316 N/A

An exception domain cannot be moved to any organisation

 323 N/A

The domain already exists in the given organisation. Please select a different organisation

 324 N/A
The Organisation id is required 322 N/A

 

Comments


0 Comments

Last Updated: Jun 10,2023