POST | /api/v1/messages/ | Allows the user to create a draft message. | |
---|---|---|---|
POST | /api/messages/ |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ActionCode | body | string | Yes | Allowable Values
|
ParentGuid | body | string | No | The guid of the parent message if this is a reply or forward. |
Password | body | string | No | The password of the parent message. This is only required if the parent message requires a password. |
AuthAuditToken | body | string | No | The authAuditToken for the parent message. This is only required if the parent message requires a password. |
CampaignGuid | body | string | No | The guid of the campaign this message is associated with. The user must be enabled for Campaigns and the Campaign must be Active. |
ExternalMessageId | body | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
MessageGuid | body | string | Yes |
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/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"}