Domain APIs

Update Domain

OVERVIEW

Update an existing domain in an organisation within Collaborate. 

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.

HTTP Request

PUT   /api/4/domains/<DOMAINID>

URL Parameters

Parameter Description
DOMAINID The domain id to be updated

Example

PUT  http://example.com/context/api/4/domains/12

HTTP Request Object

XML Request Example

 

<?xml version="1.0" encoding="UTF-8" ?>
<domain>
    <url>highq.com</url>

<status>ACTIVE/PENDING</status>
</domain>

 

JSON Request Example

 

{
   "url": "divyangupdate1Yashsadasdsdfsdfsdfu.com.us",
   "status" : "active"
}

 

HTTP Response

Success

HTTP response 200

Error

See  API Error messages 

XML Error Response

 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
    <link>https://divyanghp.local.com/divyang_4_live/api/4/error/-1</link>
    <ref>403</ref>
    <summary>Invalid input for domain status. It would be active,archive or pending.</summary>
</error>

 

Error messages

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

The given domain id is invalid

 263 N/A

A domain name is required

 265 N/A

The domain name formatting is incorrect

 266 N/A

The domain status is required

 267

N/A

The domain status is invalid. It must either be active or pending

 268

N/A

The domain name 'domainname.com' already exists

 314

N/A

 

Comments


0 Comments

Last Updated: Jun 10,2023