Move Organisation Domain
Move Organisation Domain
OVERVIEW
Overview
Move an existing domain from one organisation to another within Publisher
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.
Since v4.6
HTTP Request
POST /api/2/organisations/<ORGID>/domains/<DOMAIN>?neworganisation=<NEWORGID>
URL Parameters
| Parameter | Description |
|---|---|
| ORGID | The ID of the organisation to move the domain from |
| DOMAIN | The domain name to be moved |
| NEWORGID | The ID of the organisation to move the domain to |
HTTP Request Object
None
HTTP Headers
| HTTP Request Header | Description | Example |
|---|---|---|
| Authorization | The API Authorisation token | "Bearer XXXXXXXXXXXXX" |
| Accept |
The format of the expected response.
If no parameter is set, JSON is the default response given. |
"application/xml" |
| Content-Type |
The format of the provided content.
If no parameter is set, JSON is the expected content by default. |
"application/json" |
HTTP Response
Success
HTTP response 200
(Example below)
Error
Example HTTP Request & Response
POST http://example.com/context/api/2/organisations/3/domains/domain.com?neworganisation=4
JSON Response
{
"organisation": {
"id": 4,
"name": "New Organisation",
"link": "http://example.com/context/api/2/organisation/4"
}
}
Thank you
Your review has been submitted.
Comments
0 Comments