AlphaAlpha Docs
API Reference

Communications

Communications API

Get communication analytics

GET
/communications/analytics

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

startDate?string
Formatdate-time
endDate?string
Formatdate-time

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/communications/analytics"
{
  "byTemplate": [
    {
      "clickRate": 0.1,
      "openRate": 0.1,
      "templateId": "string",
      "templateName": "string",
      "totalClicked": 0,
      "totalOpened": 0,
      "totalSent": 0
    }
  ],
  "byType": [
    {
      "clickRate": 0.1,
      "openRate": 0.1,
      "totalClicked": 0,
      "totalOpened": 0,
      "totalSent": 0,
      "type": "OFFERTE"
    }
  ],
  "clickRate": 0.1,
  "failureRate": 0.1,
  "openRate": 0.1,
  "sendVolumeByDay": [
    {
      "count": 0,
      "date": "string"
    }
  ],
  "totalClicked": 0,
  "totalOpened": 0,
  "totalSent": 0
}
{
  "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"
}

Get all communications for a CRM entity

GET
/communications/by-entity

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

entityType*string
entityId*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/communications/by-entity?entityType=string&entityId=string"
[
  {
    "bodyHtml": "string",
    "bodyText": "string",
    "cc": [
      "string"
    ],
    "conversationId": "string",
    "date": "2019-08-24T14:15:22Z",
    "direction": "ASC",
    "fromEmail": "string",
    "fromName": "string",
    "id": "string",
    "opened": true,
    "recipients": [
      "string"
    ],
    "status": "string",
    "subject": "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"
}

Download Csv_ Communication Record

GET
/communications/csv-export

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

search?array<>
filters?array<>
page?integer
Default0
Formatint32
size?integer
Default20
Formatint32
sort?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/communications/csv-export"
"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"
}

Delete a list of entities by their IDs

DELETE
/communications/delete-list

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids*array<>

Response Body

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/communications/delete-list?ids=string"
Empty
{
  "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"
}

Dynamic Search_ Communication Record

GET
/communications/dynamic-search

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

search?array<>
filters?array<>
page?integer
Default0
Formatint32
size?integer
Default20
Formatint32
sort?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/communications/dynamic-search"
{
  "content": [
    {
      "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",
      "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",
      "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
      }
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}
{
  "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"
}

Dynamic Search Post_ Communication Record

POST
/communications/dynamic-search

Authorization

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

curl -X POST "http://localhost:18080/api/v1/communications/dynamic-search" \  -H "Content-Type: application/json" \  -d '{    "filters": {      "property1": null,      "property2": null    },    "page": 0,    "search": [      "string"    ],    "size": 0,    "sort": [      {        "ascending": true,        "field": "string"      }    ]  }'
{
  "content": [
    {
      "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",
      "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",
      "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
      }
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}
{
  "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"
}

Find by list of ids in current tenant

GET
/communications/find

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids?array<>

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/communications/find"
[
  {
    "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",
    "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",
    "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"
}

Find all for current tenant

GET
/communications/find-all

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/communications/find-all"
[
  {
    "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",
    "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",
    "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"
}

Find a list of entities by their IDs

GET
/communications/find-list

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids?array<>

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/communications/find-list"
[
  {
    "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",
    "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",
    "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"
}

Find by id in current tenant

GET
/communications/find/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/communications/find/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",
  "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",
  "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"
}
GET
/communications/link/{id}/{linkIdx}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string
linkIdx*integer
Formatint32

Response Body

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/communications/link/string/0"
Empty
{
  "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"
}

Get page by page number and size with optional sorting based on field to sortBy and direction

GET
/communications/page

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

pageNumber?integer
Formatint32
pageSize?integer
Formatint32
sortBy?string
direction?string
Value in"ASC" | "DESC"
search?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/communications/page"
{
  "content": [
    {
      "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",
      "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",
      "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
      }
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}
{
  "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"
}

Schedule an email for later delivery

POST
/communications/schedule

Authorization

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

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",
  "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",
  "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"
}

Get all scheduled emails

GET
/communications/scheduled

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/communications/scheduled"
[
  {
    "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",
    "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",
    "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"
}

Send an ad-hoc email

POST
/communications/send

Authorization

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

curl -X POST "http://localhost:18080/api/v1/communications/send" \  -H "Content-Type: application/json" \  -d '{    "body": "string",    "recipients": [      "string"    ],    "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",
  "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",
  "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"
}

Send email using a template

POST
/communications/send-template/{templateId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

templateId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/communications/send-template/string" \  -H "Content-Type: application/json" \  -d '{    "recipients": [      "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",
  "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",
  "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"
}

Tracking pixel endpoint

GET
/communications/track/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/communications/track/string"
Empty
{
  "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"
}

Delete by id in current tenant

DELETE
/communications/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/communications/string"
Empty
{
  "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"
}

Cancel a scheduled email

POST
/communications/{id}/cancel

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/communications/string/cancel"
{
  "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",
  "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",
  "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"
}

Add a comment to an entity

POST
/communications/{id}/comment

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

body*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/communications/string/comment" \  -H "Content-Type: application/json" \  -d '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"
}

Resend a failed or sent email

POST
/communications/{id}/resend

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/communications/string/resend"
{
  "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",
  "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",
  "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"
}

Get conversation thread for a communication

GET
/communications/{id}/thread

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/communications/string/thread"
{
  "inbound": [
    {
      "bodyHtml": "string",
      "bodyText": "string",
      "cc": [
        "string"
      ],
      "conversationId": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "fromEmail": "string",
      "fromName": "string",
      "graphMessageId": "string",
      "id": "string",
      "inReplyTo": "string",
      "internetMessageId": "string",
      "parentCommunicationId": "string",
      "receivedAt": "2019-08-24T14:15:22Z",
      "recipients": [
        "string"
      ],
      "relatedEntityId": "string",
      "relatedEntityType": "string",
      "status": "NEW",
      "subject": "string",
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "outbound": [
    {
      "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",
      "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",
      "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"
}

Communication Settings

Previous Page

Company Bank Accounts

Next Page