Message

POST /ver2/MessageService.svc/messages

Queues a message for delivery to the Enviance Inbox for a specified recipient, as well as optionally to the recipient e-mail address.

Security: All users

SDK API: envianceSdk.messages.createMessage(messageInfo, onsuccess, onerror)

POST /ver2/MessageService.svc/messages/ HTTP/1.1
 
{
  "messageInfo": {
    "id": "d8ac14f5-c4b1-4db2-b0fc-15452f71737d",
    "recipientId": "d2148a6f-4989-4a61-9c27-855a110f8c68",
    "sentById": "21e1f9b6-fc7c-4257-85f1-01d097762d09",
    "sentOn": "2013-06-14T14:07:52",
    "subject": "Report Completion Notification: \"Emergency Checklist Report\"",
    "body": "This is to notify you that the \"Emergency Checklist Report\" is complete.",
    "type": "EmailNotification",
    "archived": false,
    "read": false,
    "sendByEmail": true
  }
}

envianceSdk.messages.createMessage

[
  {
    "recipientIdOrUserName": "5bfdbd05-225f-40ee-bff1-2efe18a75375",
    "subject": "subject text",
    "body": "body text",
    "sendByEmail": true
  },
  "onsuccess",
  "onerror"
]

Request

Headers

EnvApi-Systemidstring

Specify specific system to run instead of Home

EnvApi-Packageidstring

(optional) Clients application/package ID

EnvApi-Udf-DateTime-Iso-In-CustomFieldsstring

Udfs of DateTime should use Iso

EnvApi-Udf-DateTime-ReadInUserTzstring

(obsolete) Udfs of DateTime type whould be in ReadInUserTz

EnvApi-Udf-Value-Invariantstring

(optional) Udfs - Force Non-Localized (invariant) values

EnvApi-Localization-Allstring

(optional) Extend objects with User-given Localizations

x-client-request-idstring

(optional) Client ID for double submit prevention

Request body

Response

not available

Changes

No recorded changes to this operation across all 1 revision of this API.