> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mapp.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Find prepared messages
> 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
}
## OpenAPI
````json POST /preparedmessage/find
{
"openapi": "3.0.4",
"info": {
"title": "Engage public API",
"version": "1"
},
"servers": [
{
"url": "https://your-engage-domain.com/api/rest"
}
],
"tags": [
{
"name": "Address Attributes"
},
{
"name": "Async"
},
{
"name": "Audit Log"
},
{
"name": "Automation"
},
{
"name": "Blacklist"
},
{
"name": "CMS"
},
{
"name": "Contact"
},
{
"name": "Content"
},
{
"name": "Coupon"
},
{
"name": "Draft Message"
},
{
"name": "Ecommerce"
},
{
"name": "Group"
},
{
"name": "Group Attributes"
},
{
"name": "Landing Page"
},
{
"name": "Member Attributes"
},
{
"name": "Membership"
},
{
"name": "Message"
},
{
"name": "Meta"
},
{
"name": "Mobile Push"
},
{
"name": "Prepared Message"
},
{
"name": "Process"
},
{
"name": "Profile Attributes"
},
{
"name": "Related Data"
},
{
"name": "Segmentation"
},
{
"name": "System"
},
{
"name": "System User"
},
{
"name": "Usage Statistics"
},
{
"name": "User"
},
{
"name": "Whiteboard"
}
],
"paths": {
"/preparedmessage/find": {
"post": {
"tags": [
"Prepared Message"
],
"summary": "Find prepared messages",
"description": "Returns a list of prepared messages matching a JSON request body filter. At least one of externalMessageId, creationDateFrom or lastUpdateDateFrom must be non-blank.{
\"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
}",
"operationId": "FindPreparedMessage",
"requestBody": {
"description": "JSON filter for prepared messages. At least one of externalMessageId, creationDateFrom or lastUpdateDateFrom must be non-blank. Optional limit: 1-500, default 500.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PreparedMessageFilter"
}
}
},
"required": true,
"x-bodyName": "body"
},
"responses": {
"200": {
"description": "",
"content": {
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/PreparedMessageSummary"
}
}
}
},
"400": {
"description": "",
"content": {
"application/octet-stream": {}
}
}
}
}
}
},
"components": {
"schemas": {
"PreparedMessageFilter": {
"type": "object",
"properties": {
"externalMessageId": {
"type": "string"
},
"limit": {
"type": "integer",
"format": "int32"
},
"messageName": {
"type": "string"
},
"subjectLine": {
"type": "string"
},
"authorName": {
"type": "string"
},
"authorId": {
"type": "integer",
"format": "int64"
},
"messageCategoryId": {
"type": "integer",
"format": "int64"
},
"groupName": {
"type": "string"
},
"groupId": {
"type": "integer",
"format": "int64"
},
"groupCategoryName": {
"type": "string"
},
"groupCategoryId": {
"type": "integer",
"format": "int64"
},
"creationDateFrom": {
"type": "string"
},
"creationDateTo": {
"type": "string"
},
"lastUpdateDateFrom": {
"type": "string"
},
"lastUpdateDateTo": {
"type": "string"
}
}
},
"PreparedMessageSummary": {
"type": "object",
"properties": {
"authorId": {
"type": "integer",
"format": "int64"
},
"authorName": {
"type": "string"
},
"creationDate": {
"type": "string"
},
"externalMessageId": {
"type": "string"
},
"groupCategoryId": {
"type": "integer",
"format": "int64"
},
"groupCategoryName": {
"type": "string"
},
"groupId": {
"type": "integer",
"format": "int64"
},
"groupName": {
"type": "string"
},
"id": {
"type": "integer",
"format": "int64"
},
"isArchived": {
"type": "boolean",
"default": false
},
"isSystemMessage": {
"type": "boolean",
"default": false
},
"lastUpdateDate": {
"type": "string"
},
"messageCategoryId": {
"type": "integer",
"format": "int64"
},
"messageName": {
"type": "string"
},
"subjectLine": {
"type": "string"
},
"senderProfile": {
"type": "string"
}
}
}
}
}
}
````