Description

Returns a list of messages matching the filter criteria.
Can be used both for a sent or a prepared message.

Available from

v7

Request path

POST [REST URL]/message/find

Query Parameters

Parameter

Type

Description

filter

MessageFilter

A filter with the list of returned messages.

Example body

{
  "groupId": 650557972,
  "sendoutDateFrom": "2018-09-01T00:00:00",
  "sendoutDateTo": "2018-10-01T00:00:00"
}

Example body 2

{
  "sendoutDateFrom": "2018-09-01T00:00:00",
  "sendoutDateTo": "2018-10-01T00:00:00"
}


Example response

[{
   "authorId": 45803225,
   "authorName": "Smith,John",
   "externalMessageId": null,
   "groupCategoryId": null,
   "groupId": 2900,
   "id": 7018,
   "isArchived": false,
   "isSystemMessage": false,
   "messageCategoryId": null,
   "messageName": "Test Email_17.11.",
   "originalMessageId": null,
   "sendoutDate": "2021-11-17T13:17:54Z",
   "status": "SENT",
   "subjectLine": "Test Email 17.11.",
   "type": "NORMAL",
   "sendoutStartDate": "2021-11-17T13:17:54Z",
   "sendoutEndDate": "2021-11-17T13:17:55Z",
   "transferDate": "2021-11-17T13:17:53Z",
   "transferStartDate": null,
   "transferEndDate": null,
   "scheduleDate": "2021-11-17T13:17:53Z",
   "isPreprocessing": "false",
   "senderProfile": null
}]