> ## 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.
# Update a prepared message
> Update prepared message.
trackingOverride controls message tracking consent override behavior:
1 = no override; per-contact tracking consent applies.
2 = full override; open and link-click tracking are enforced for all recipients regardless of individual consent.
3 = anonymized aggregate tracking for recipients whose consent is denied or withdrawn.
Any other value is rejected by this API.
On update, omit trackingOverride or send null to preserve the existing stored value; set trackingOverride to 1 explicitly to clear an active override.
## OpenAPI
````json POST /preparedmessage/update
{
"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/update": {
"post": {
"tags": [
"Prepared Message"
],
"summary": "Update a prepared message",
"description": "Update prepared message.
trackingOverride controls message tracking consent override behavior:
1 = no override; per-contact tracking consent applies.
2 = full override; open and link-click tracking are enforced for all recipients regardless of individual consent.
3 = anonymized aggregate tracking for recipients whose consent is denied or withdrawn.
Any other value is rejected by this API.
On update, omit trackingOverride or send null to preserve the existing stored value; set trackingOverride to 1 explicitly to clear an active override.",
"operationId": "UpdatePreparedMessage",
"requestBody": {
"description": "Prepared message body.
trackingOverride controls message tracking consent override behavior:
1 = no override; per-contact tracking consent applies.
2 = full override; open and link-click tracking are enforced for all recipients regardless of individual consent.
3 = anonymized aggregate tracking for recipients whose consent is denied or withdrawn.
Any other value is rejected by this API.
On update, omit trackingOverride or send null to preserve the existing stored value; set trackingOverride to 1 explicitly to clear an active override.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PreparedMessage"
}
}
},
"required": true,
"x-bodyName": "body"
},
"responses": {
"204": {
"description": "",
"content": {
"application/octet-stream": {}
}
},
"400": {
"description": "",
"content": {
"application/octet-stream": {}
}
}
}
}
}
},
"components": {
"schemas": {
"PreparedMessage": {
"type": "object",
"properties": {
"contactId": {
"type": "integer",
"format": "int64"
},
"messageId": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"groupId": {
"type": "integer",
"format": "int64"
},
"groupName": {
"type": "string"
},
"selectionId": {
"type": "integer",
"format": "int64"
},
"selectionName": {
"type": "string"
},
"channelId": {
"type": "integer",
"format": "int64"
},
"channelName": {
"type": "string"
},
"externalId": {
"type": "string"
},
"messageCategoryId": {
"type": "integer",
"format": "int64"
},
"messageCategoryName": {
"type": "string"
},
"message": {
"$ref": "#/components/schemas/MessageBase"
},
"trackingOverride": {
"type": "integer",
"format": "int64"
}
}
},
"MessageBase": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"emailBodyText": {
"type": "string"
},
"emailBodyHtml": {
"type": "string"
},
"smsText": {
"type": "string"
},
"faxText": {
"type": "string"
},
"emailHeaders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Attribute"
}
},
"attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Attachment"
}
},
"attachmentReferences": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AttachmentReference"
}
},
"encoding": {
"type": "string"
},
"encodingSMS": {
"type": "string"
},
"imageHandlingMode": {
"type": "string"
}
}
},
"Attribute": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"Attachment": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"contentType": {
"type": "string"
},
"content": {
"type": "string"
}
}
},
"AttachmentReference": {
"type": "object",
"properties": {
"contentId": {
"type": "string"
},
"reference": {
"type": "string"
}
}
}
}
}
}
````