Description

Returns a list of message summary objects that contain information about the messages that match the filter criteria.
You can use this method to retrieve information about a message that has been sent or saved as 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": 279975,
      "authorName": "Smith, John",
      "externalMessageId": null,
      "groupCategoryId": null,
      "groupId": 378,
      "id": 677,
      "isArchived": false,
      "isSystemMessage": false,
      "messageCategoryId": null,
      "messageName": "John SMS 20180807",
      "originalMessageId": null,
      "sendoutDate": "2018-08-07T10:53:14Z",
      "status": "SENT",
      "subjectLine": null,
      "type": "NORMAL",
      "sendoutStartDate": null,
      "sendoutEndDate": null,
      "transferDate": null,
      "transferStartDate": null,
      "transferEndDate": null,
      "senderProfile": null
   }
]