POST/partners/customers/{domainId}/upgrade-domain

Adds a domain name to change a group name to.

Authorization

oauth2

OAuth 2.0 authentication.
For more information, see Authentication and Authorization.

Scope

partner

HTTP Request

POSThttps://www.worksapis.com/v1.0/partners/customers/{domainId}/upgrade-domain

Path Parameters

ParameterTypeDescription
domainId integer 

Domain ID


required
example : 10000001 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Request Body

PropertyTypeDescription
domain string 

Domain name


required 

Request Example

example

1{2  "domain": "example.com"3}

Response

HTTP 201

OK

PropertyTypeDescription
domain string 

Domain name to upgrade to

 
isActiveDomain boolean 

Indicates whether the domain is active (or its ownership is verified).


default : false 
cnameHost string 

CNAME host name

 
cnameTarget string 

CNAME target

 
txtHost string 

TXT host name

 
txtToken string 

TXT token

 
mxRecordHost string 

MX record host name

 
mxRecordValue object (mxRecordValue) 

MX record value

 

mxRecordValue

PropertyTypeDescription
priority10 string 

Priority 10

 
priority20 string 

Priority 20

 

Response Example

example

1{2  "domain": "example.com",3  "isActiveDomain": true,4  "cnameHost": "XXXXXXXXXXXX",5  "cnameTarget": "XXXXXXXXXXXX",6  "txtHost": "XXXXXXXXXXXX",7  "txtToken": "XXXXXXXXXXXX",8  "mxRecordHost": "XXXXXXXXXXXX",9  "mxRecordValue": {10    "priority10": "XXXXXXXXXXXX",11    "priority20": "XXXXXXXXXXXX"12  }13}