POST | /api/services/{ServiceGuid}/users/emailaliases | Add a new email alias for a service user. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ServiceGuid | path | Guid | Yes | |
ServiceUserGuid | body | Guid | No | |
EmailAddress | body | string | No | |
EmailAlias | body | string | No | |
PromoteToMasterOnConfirmation | body | Boolean | No | Allowable 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.
POST /api/services/{ServiceGuid}/users/emailaliases HTTP/1.1
Host: api.secure-messaging.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{
"serviceGuid": "00000000000000000000000000000000",
"serviceUserGuid": "00000000000000000000000000000000",
"emailAddress": "String",
"emailAlias": "String",
"promoteToMasterOnConfirmation": 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" } } }