Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Returns a list of message summary objects that contain information about the messages that match messages matching the filter criteria.
You can use this method to retrieve information about a message that has been sent or saved as 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

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

Example body 2

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


Example response

Code Block
[
      {
      "authorId": 27997545803225,
  
   "authorName": "Smith, John",
 
    "externalMessageId": null,
  
   "groupCategoryId": null,

     "groupId": 3782900,
      "id": 6777018,
  
   "isArchived": false,

     "isSystemMessage": false,
      "messageCategoryId": null,
  
   "messageName": "John SMS 20180807Test Email_17.11.",
 
    "originalMessageId": null,
      "sendoutDate": "20182021-0811-07T1017T13:5317:14Z54Z",
  
   "status": "SENT",
      "subjectLine": null,"Test Email 17.11.",
    "type": "NORMAL",
      "sendoutStartDate": null"2021-11-17T13:17:54Z",
      "sendoutEndDate": null,
  "2021-11-17T13:17:55Z",
   "transferDate": null,
  "2021-11-17T13:17:53Z",
   "transferStartDate": null,
   "transferEndDate": null,
   "transferEndDatescheduleDate": null"2021-11-17T13:17:53Z",
   "isPreprocessing": "false",
   "senderProfile": null
 
 }
]