Secure Messaging API v7.1.18274.2 - DEBUG

<back to all web services

PreCreateMessage

The following routes are available for this service:
POST/api/v1/messages/Allows the user to create a draft message.
POST/api/messages/
PreCreateMessage Parameters:
NameParameterData TypeRequiredDescription
ActionCodebodystringYes

Allowable Values

  • New
  • Reply
  • ReplyAll
  • Forward
ParentGuidbodystringNoThe guid of the parent message if this is a reply or forward.
PasswordbodystringNoThe password of the parent message. This is only required if the parent message requires a password.
AuthAuditTokenbodystringNoThe authAuditToken for the parent message. This is only required if the parent message requires a password.
CampaignGuidbodystringNoThe guid of the campaign this message is associated with. The user must be enabled for Campaigns and the Campaign must be Active.
ExternalMessageIdbodystringNo
PreCreateMessageResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
MessageGuidbodystringYes

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: Forbidden (403) - System Error Code: Forbidden 929 - Parent Message not found 38 - Incorrect For Your Eyes Only password. 907 - User does not have access to this Message. 928 - Validation error 909 - User cannot forward this message. 908 - User 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/PreCreateMessage HTTP/1.1 
Host: cirius10.secure-messaging.com 
Content-Type: application/json
Content-Length: length

{"actionCode":"String","parentGuid":"00000000000000000000000000000000","password":"String","authAuditToken":"String","campaignGuid":"00000000000000000000000000000000","externalMessageId":"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"}},"messageGuid":"00000000000000000000000000000000"}