Alpha API ReferenceCommunications
Schedule an email for later delivery
AuthorizationBearer <token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/communications/schedule" \ -H "Content-Type: application/json" \ -d '{ "body": "string", "recipients": [ "string" ], "scheduledAt": "2019-08-24T14:15:22Z", "subject": "string" }'{
"bcc": [
"string"
],
"body": "string",
"cc": [
"string"
],
"clickedLinks": [
{
"clickCount": 0,
"clickedAt": "2019-08-24T14:15:22Z",
"originalUrl": "string",
"url": "string"
}
],
"conversationId": "string",
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"errorMessage": "string",
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"id": "string",
"internetMessageId": "string",
"linkTrackingEnabled": true,
"messageId": "string",
"number": "string",
"openCount": 0,
"opened": true,
"openedAt": "2019-08-24T14:15:22Z",
"originalBody": "string",
"providerType": "RESEND",
"recipientListId": "string",
"recipients": [
"string"
],
"relatedEntityId": "string",
"relatedEntityType": "string",
"replyTo": "string",
"scheduledAt": "2019-08-24T14:15:22Z",
"senderEmail": "string",
"senderMailbox": "string",
"senderName": "string",
"sentAt": "2019-08-24T14:15:22Z",
"status": "PENDING",
"subject": "string",
"templateId": "string",
"templateName": "string",
"tenantId": "string",
"trackingEnabled": true,
"type": "OFFERTE",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variables": {
"property1": null,
"property2": null
}
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}