> ## 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 CMS framework > Required: frameworkId, name. Update is a full replace, not a patch: send every field you want to keep. Fields left out are cleared. This includes content and variables. variables holds design variables (colors, sizes, links), not recipient data, as a JSON object serialized as a string. Each key maps to a definition: id, name, type (text, list or toggle), value (always a string), group, order and inline ("true" or "false" as a string); list adds options (label to value), toggle adds trueValue and falseValue. Content refers to a variable as ${key}. ## OpenAPI ````json PUT /cmsFrameworks/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 (legacy)" }, { "name": "CMS Blocks" }, { "name": "CMS Frameworks" }, { "name": "CMS Messages" }, { "name": "CMS Templates" }, { "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": { "/cmsFrameworks/update": { "put": { "tags": [ "CMS Frameworks" ], "summary": "Updates an existing framework identified by its numeric ID.", "description": "Required: frameworkId, name. Update is a full replace, not a patch: send every field you want to keep. Fields left out are cleared. This includes content and variables. variables holds design variables (colors, sizes, links), not recipient data, as a JSON object serialized as a string. Each key maps to a definition: id, name, type (text, list or toggle), value (always a string), group, order and inline (\"true\" or \"false\" as a string); list adds options (label to value), toggle adds trueValue and falseValue. Content refers to a variable as ${key}.", "operationId": "cmsFrameworksUpdate", "parameters": [ { "name": "frameworkId", "in": "query", "description": "The numeric ID of the framework.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "The framework.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FrameworkData" } } }, "required": true, "x-bodyName": "body" }, "responses": { "200": { "description": "The updated framework.\n\nExample response:\n```json\n{\n \"id\": 9070,\n \"name\": \"Newsletter layout\",\n \"description\": \"One-column newsletter\",\n \"content\": \"
#tplBlockArea(\\\"main\\\")
\",\n \"tags\": \"newsletter\",\n \"encoding\": \"UTF-8\",\n \"lifecycleStatus\": \"ACTIVE\",\n \"status\": \"WORKINPROGRESS\",\n \"variables\": \"{\\\"defaultBGColor\\\": {\\\"id\\\": \\\"def-bgColor\\\", \\\"name\\\": \\\"Default Background Color\\\", \\\"type\\\": \\\"text\\\", \\\"value\\\": \\\"#FFFFFF\\\", \\\"group\\\": \\\"System Defaults\\\", \\\"order\\\": 1, \\\"inline\\\": \\\"false\\\"}, \\\"imagetype\\\": {\\\"id\\\": \\\"314f6ef8-37df-470a-beea-6b630832df29\\\", \\\"name\\\": \\\"Image Link Settings\\\", \\\"type\\\": \\\"list\\\", \\\"value\\\": \\\"withlink\\\", \\\"options\\\": {\\\"Image w/ URL\\\": \\\"withlink\\\", \\\"Image w/o URL\\\": \\\"nolink\\\"}, \\\"group\\\": \\\"Variables\\\", \\\"order\\\": 2, \\\"inline\\\": \\\"false\\\"}}\",\n \"createDate\": 1792998000000,\n \"modifyDate\": 1793001600000,\n \"version\": 2\n}\n```", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FrameworkWriteResult" } } } }, "400": { "description": "Error. All errors are returned as HTTP 400; errorCode in the body says what went wrong: INVALID_PARAMETER or MISSING_PARAMETER (a parameter is missing or invalid), NO_SUCH_OBJECT (no object with this ID in your account), PERMISSION_DENIED (your user lacks the CMS permission for this action), UNEXPECTED_ERROR (backend error). Example: {\"errorActor\": \"CLIENT\", \"errorCode\": \"NO_SUCH_OBJECT\", \"message\": \"...\", \"objectType\": null, \"propertyName\": null, \"propertyValue\": null}", "content": { "application/json": {} } } } } } }, "components": { "schemas": { "FrameworkData": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "content": { "type": "string" }, "tags": { "type": "string" }, "encoding": { "type": "string" }, "imageHandlingMode": { "enum": [ "host", "inline", "none" ], "type": "string" }, "variables": { "type": "string" }, "lifecycleStatus": { "enum": [ "ACTIVE", "ARCHIVED" ], "type": "string" } } }, "FrameworkWriteResult": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "description": { "type": "string" }, "content": { "type": "string" }, "tags": { "type": "string" }, "encoding": { "type": "string" }, "lifecycleStatus": { "enum": [ "ACTIVE", "ARCHIVED" ], "type": "string" }, "status": { "enum": [ "FINISHED", "WORKINPROGRESS" ], "type": "string" }, "variables": { "type": "string" }, "createDate": { "type": "integer", "format": "int64" }, "modifyDate": { "type": "integer", "format": "int64" }, "version": { "type": "integer", "format": "int32" } } } } } } ````