| PUT | /api/services/{ServiceGuid}/domains/{Domain} | Update the name of a domain of a service and/or whether it is the primary domain for that service. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ServiceGuid | path | Guid | Yes | The ServiceGuid of the service that contains the domain to be updated. |
| Domain | path | String | Yes | The Domain to be updated |
| NewDomain | query | String | Yes | The new Domain name. New Domains must be unique across all Services in the system. |
| SetAsPrimaryDomain | query | Boolean | Yes | The flag indicating whether the Domain becomes the new PrimaryDomain for the serviceAllowable Values
|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /api/services/{ServiceGuid}/domains/{Domain} HTTP/1.1
Host: api.secure-messaging.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{
"serviceGuid": "00000000000000000000000000000000",
"domain": "String",
"newDomain": "String",
"setAsPrimaryDomain": false
}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{
"responseStatus": {
"errorCode": "String",
"message": "String",
"stackTrace": "String",
"errors": [
{
"errorCode": "String",
"fieldName": "String",
"message": "String",
"meta": {
"String": "String"
}
}
],
"meta": {
"String": "String"
}
}
}