Find prepared messages

Prev Next
Post
/preparedmessage/find

Returns a list of prepared messages matching a JSON request body filter. At least one of externalMessageId, creationDateFrom or lastUpdateDateFrom must be non-blank.
Dates accept ISO 8601 timestamps or YYYY-MM-DD values. For each date range (creationDateFrom/creationDateTo and lastUpdateDateFrom/lastUpdateDateTo), a To date requires its corresponding From date and must be later than it. An omitted To date defaults to the end of the current day; a date-only To value means the end of that day. Each range must span no more than 31 calendar days, including when the To date is omitted.
The optional limit must be between 1 and 500 inclusive and defaults to 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",
"lastUpdateDateTo" : "2020-07-15",
"messageName" : "MessageToBeArchived",
"limit":1
}

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

JSON filter for prepared messages. At least one of externalMessageId, creationDateFrom or lastUpdateDateFrom must be non-blank. Optional limit: 1-500, default 500.

object
externalMessageId
string
limit
integer (int32)
messageName
string
subjectLine
string
authorName
string
authorId
integer (int64)
messageCategoryId
integer (int64)
groupName
string
groupId
integer (int64)
groupCategoryName
string
groupCategoryId
integer (int64)
creationDateFrom
string
creationDateTo
string
lastUpdateDateFrom
string
lastUpdateDateTo
string
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
Defaultfalse
isSystemMessage
boolean
Defaultfalse
lastUpdateDate
string
messageCategoryId
integer (int64)
messageName
string
subjectLine
string
senderProfile
string
400