Alpha API ReferenceCrm email campaigns
Create and immediately send a campaign in one call
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/crm/email-campaigns/send" \ -H "Content-Type: application/json" \ -d '{ "body": "string", "includeSignature": true, "leadIds": [ "string" ], "name": "string", "subject": "string" }'{
"body": "string",
"clickedCount": 0,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"failedCount": 0,
"fromEmail": "string",
"id": "string",
"includeSignature": true,
"language": "string",
"name": "string",
"number": "string",
"openedCount": 0,
"recipients": [
{
"clickedAt": [
"2019-08-24T14:15:22Z"
],
"companyName": "string",
"email": "string",
"errorMessage": "string",
"firstName": "string",
"lastName": "string",
"leadId": "string",
"openedAt": "2019-08-24T14:15:22Z",
"repliedAt": "2019-08-24T14:15:22Z",
"sentAt": "2019-08-24T14:15:22Z",
"sentMailId": "string",
"status": "PENDING"
}
],
"repliedCount": 0,
"replyTo": "string",
"senderName": "string",
"sentAt": "2019-08-24T14:15:22Z",
"sentCount": 0,
"skippedCount": 0,
"sourceTemplateId": "string",
"status": "DRAFT",
"subject": "string",
"tenantId": "string",
"totalRecipients": 0,
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "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"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}