POST | /api/services/{ServiceGuid}/domains/{Domain} | Add a Domain to a Service. | If this is the first domain to be added to the Service, this domain will marked as the Primary Domain for that Service. Domains must be unique across all Services in the system. |
---|---|---|---|
DELETE | /api/services/{ServiceGuid}/domains/{Domain} | Remove a Domain from a Service. | If this domain was the Primary domain, the Primary domain for the Service will be nulled. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ServiceGuid | path | Guid | Yes | The ServiceGuid that you want to add / remove the domain to. |
Domain | path | String | Yes | The domain name for the Service. |
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.
POST /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"
}
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" } } }