Secure Messaging API v8.19.8.0

<back to all web services

SaveMessage

The following routes are available for this service:
PUT/api/v1/messages/{MessageGuid}/saveAllows the user to save a draft message.
PUT/api/messages/{MessageGuid}/save
SaveMessage Parameters:
NameParameterData TypeRequiredDescription
MessageGuidpathstringYes
TobodyarrayNo
CcbodyarrayNo
BccbodyarrayNo
SubjectbodystringNo
BodybodystringNo
BodyFormatbodystringYes

Allowable Values

  • Text
  • Html
MessageOptionsbodyMessageOptionsNoWhen omitted, the services default message options are used.
ExpiryDatebodystringNoMessage to expire on this date in accordance with expiry policy.
ExpiryGroupbodystringNo

Allowable Values

  • Always
MessageOptions Parameters:
NameParameterData TypeRequiredDescription
AllowForwardbodybooleanNo

Allowable Values

  • true
  • false
AllowReplybodybooleanNo

Allowable Values

  • true
  • false
AllowReplyAllbodybooleanNo

Allowable Values

  • true
  • false
AllowTrackingbodybooleanNo

Allowable Values

  • true
  • false
FYEOTypebodystringNo

Allowable Values

  • Disabled
  • AccountPassword
  • UniquePassword
ShareTrackingbodybooleanNo

Allowable Values

  • true
  • false
SaveMessageResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

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

Error Codes:

Http Error Code: Unauthorized (401) - System Error Code: Unauthorized 811 - The user session is no longer valid.
Http Error Code: NotFound (404) - System Error Code: NotFound 929 - Message not found
Http Error Code: Forbidden (403) - System Error Code: Forbidden 930 - This user doesn't have access to Confidential. 922 - This user doesn't have access to FYEO. 77 - You cannot reply to this message.

HTTP + JSON

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"}}}