Exception domain APIs

Update exception domain

OVERVIEW

Overview

This API call is used to change an exception domain within an organisation object in the system. 

HTTP Request

PUT  /api/5/exceptiondomains/<DOMAINID>

URL Parameters
Parameter Description
DOMAINID The domain id to be updated

 

HTTP Request

PUT http://example.com/context/api/5/exceptiondomains/12

 

XML Request Example

<domain>
        <url>highq.com</url>
        <status>ARCHIVE</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>
    <ref>403</ref>
    <summary>Invalid input for domain status. It would be active 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 invalid. It must either be active or pending

 268

N/A

The domain name 'domainname.com' already exists

 314

N/A

An anonymous domain cannot be updated

 392  

 

Comments


0 Comments

Last Updated: Jun 09,2023