Domain APIs

Add Domain

OVERVIEW

This method is used to add a new domain to an organisation within Collaborate. This API call is used to add a new domain to an organisation object in the system.

HTTP Request

POST   /api/4/domains?orgid=<ORGID>

 

Parameter  Description 
ORGID The ID of the organisation to add the new domain to 

Example

POST  http://example.com/context/api/4/domains?orgid=3

 

HTTP Request Object

XML Request Example

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

    <status>ACTIVE/PENDING/ARCHIVE</status>

</domain>

JSON Request Example

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

HTTP Response

Success

HTTP response 201

Error

See  API Error messages 

 

XML Success Response

<?xml version="1.0" encoding="UTF-8" ?>
<domain>
    <domainID>3</domainID>
    <name>HighQ</name>
    <link>https://divyanghp.local.com/divyang_4_live/api/4/domain/3</link>
</domain>

 

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>The domain name 'divyangupdate1Yashsadasdsdfsdfsdfu.com.us' already exists</summary>
</error>

 

Error messages

 

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

The Organisation id is invalid

 260 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

The contact person's email address domain is already being used by another organisation

 315 N/A

 

Comments


0 Comments

Last Updated: Jun 10,2023