Organisation APIs

Update Organisation Domain

OVERVIEW

Overview

Update an existing domain in an organisation within Publisher.  This API call is used to change a domain within an organisation object in the system. This in turn will update the email address of all users within that organisation who have this domain assigned to their email address.

Since v4.6

Enhanced v5.0

HTTP Request

PUT  /api/2/organisations/<ID>/domains/<DOMAIN>

URL Parameters
Parameter Description
ID The ID of the organisation to update the domain within
DOMAIN The domain name to be updated

 

HTTP Request Object

Domain object, either in JSON or XML format.

 

HTTP Headers
HTTP Request Header Description Example
Authorization The API Authorisation token "Bearer XXXXXXXXXXXXX"
Accept

The format of the expected response. 

  • "application/json"
  • "application/xml"

If no parameter is set, JSON is the default response given.

 "application/xml"
Content-Type

The format of the provided content.

  • "application/json"
  • "application/xml"

If no parameter is set, JSON is the expected content by default.

 "application/json"

 

HTTP Response

Success

HTTP response 200

(Example below)

 

Error

See API Error messages

 

Example HTTP Request & Response

Change domain "highqsolutions.com" to "highq.com"

PUT http://example.com/context/api/2/organisations/3/domains/highqsolutions.com

 

JSON Request

{

    "domain": {

        "url": "highq.com"

    }

}

 

 

JSON Response

{

    "domain": {
        "id": 170,
        "url": "highq.com",
        "status": "Active"
    }

}

 

 

Comments


0 Comments

Last Updated: Nov 08,2024