/preparedmessage/find
  • 1 Minute to read
  • Dark
    Light

/preparedmessage/find

  • Dark
    Light

Article summary

Post
/preparedmessage/find

Returns list of prepared messages. At least one of the following two fields is mandatory:

'lastUpdateDateFrom'

'creationDateFrom' - must be within 31 days of CreationDateTo.

CreationDateTo if is not given then by default is currentDate, if is given than obligatory is to use creationDateFrom as well.

To get the result faster, use limit (1-500)
Request body examples:

{
"externalMessageId": "MessageID"
}

{
"creationDateFrom": "2020-07-10",
"messageName" : "MessageToBeArchived",
"limit":1
}

{
"creationDateFrom": "2020-07-10",
"creationDateTo" : "2020-07-15",
"messageName" : "MessageToBeArchived",
"limit":1
}

{
"lastUpdateDateFrom": "2020-07-17",
"messageName" : "MessageToBeArchived",
"limit":1
}

{
"lastUpdateDateFrom": "2020-07-10",
"creationDateTo" : "2020-07-15",
"messageName" : "MessageToBeArchived",
"limit":1
}

{
"creationDateFrom": "2020-07-01",
"lastUpdateDateFrom": "2020-07-10",
"creationDateTo" : "2020-07-15",
"messageName" : "MessageToBeArchived",
"limit":1
}

Query parameters
preparedMessageFilter
stringRequired

A filter with the list of prepared message.

Responses
200
object
authorId
integer (int64)
authorName
string
creationDate
string
externalMessageId
string
groupCategoryId
integer (int64)
groupCategoryName
string
groupId
integer (int64)
groupName
string
id
integer (int64)
isArchived
boolean
Default"False"
isSystemMessage
boolean
Default"False"
lastUpdateDate
string
messageCategoryId
integer (int64)
messageName
string
subjectLine
string
senderProfile
string
400

Was this article helpful?

What's Next