PUT | /api/v1/messages/{MessageGuid}/save | Allows the user to save a draft message. | |
---|---|---|---|
PUT | /api/messages/{MessageGuid}/save |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
MessageGuid | path | string | Yes | |
To | body | array | No | |
Cc | body | array | No | |
Bcc | body | array | No | |
Subject | body | string | No | |
Body | body | string | No | |
BodyFormat | body | string | Yes | Allowable Values
|
MessageOptions | body | MessageOptions | No | When omitted, the services default message options are used. |
ExpiryDate | body | string | No | Message to expire on this date in accordance with expiry policy. |
ExpiryGroup | body | string | No | Allowable Values
|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AllowForward | body | boolean | No | Allowable Values
|
AllowReply | body | boolean | No | Allowable Values
|
AllowReplyAll | body | boolean | No | Allowable Values
|
AllowTracking | body | boolean | No | Allowable Values
|
FYEOType | body | string | No | Allowable Values
|
ShareTracking | 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 /json/reply/SaveMessage HTTP/1.1
Host: cirius10.secure-messaging.com
Content-Type: application/json
Content-Length: length
{"messageGuid":"00000000000000000000000000000000","to":["String"],"cc":["String"],"bcc":["String"],"subject":"String","body":"String","bodyFormat":"String","messageOptions":{"allowForward":false,"allowReply":false,"allowReplyAll":false,"allowTracking":false,"fyeoType":"String","shareTracking":false},"expiryDate":"0001-01-01T00:00:00.0000000Z","expiryGroup":"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"}}}