Create
This operation is part of the Email API section of the Web Services API.
Overview
Create a new empty email interaction.
Request URL | /api/v2/me/emails |
---|---|
HTTP Method | POST |
Required Features | api-multimedia |
Parameters
Parameter | Value |
---|---|
operationName | Create |
parentId | The ID of an interaction that's the parent of this email. (optional) |
queueUri | The queue URI for the specified email. |
userData | The key value data to attach. (optional) |
Sample
Request
HTTP POST /api/v2/me/emails { "operationName": "Create", "queueUri": "http://localhost:8080/api/v2/queues/995655ec-81a5-46b0-82d0-3f2c5eca263d" }
Response
{ "statusCode": 0 }
Notification
{ "referenceId": 22, "notificationType": "StatusChange", "messageType": "EmailStateChangeMessage", "email": { "state": "Composing", "id": "01QG9WAK37H38024", "capabilities": [ "Cancel", "Send", "AddComment", "AttachUserData", "UpdateUserData", "DeleteUserData", "SetDisposition", "SetInFocus", "Transfer" ], "uri": "http: //localhost: 8080/api/v2/email/01QG9WAK37H38024" } }
Item | Description |
---|---|
messageType | Denotes the category of message. |
notificationType | Denotes the purpose of the notification. |
The element containing all email specific data. |
This page was last edited on January 22, 2016, at 19:56.
Comments or questions about this documentation? Contact us for support!