> ## 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 coupon list metadata > Updates only non-null name, description, previewText and defaultText fields. Omitted or null fields retain their current values. Empty strings clear description or defaultText; empty previewText resets it to the list name followed by _previewCoupon. Preview text accepts up to 200 characters; default text accepts up to 500 characters. an empty name is invalid. An empty settings object leaves metadata unchanged. couponListName identifies the current list; a non-null settings.name renames it. Owner and archive state are unchanged. Omitted or null reminder fields retain their current values. A non-negative remindThreshold enables reminders; zero means remind when empty. reminderEnabled=false clears the threshold and additional recipient. reminderEnabled=true requires a supplied or existing threshold. Empty additionalReminderEmail clears that recipient. ## OpenAPI ````json POST /couponList/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": { "/couponList/update": { "post": { "tags": [ "Coupon" ], "summary": "Update coupon list metadata", "description": "Updates only non-null name, description, previewText and defaultText fields. Omitted or null fields retain their current values. Empty strings clear description or defaultText; empty previewText resets it to the list name followed by _previewCoupon. Preview text accepts up to 200 characters; default text accepts up to 500 characters. an empty name is invalid. An empty settings object leaves metadata unchanged. couponListName identifies the current list; a non-null settings.name renames it. Owner and archive state are unchanged. Omitted or null reminder fields retain their current values. A non-negative remindThreshold enables reminders; zero means remind when empty. reminderEnabled=false clears the threshold and additional recipient. reminderEnabled=true requires a supplied or existing threshold. Empty additionalReminderEmail clears that recipient.", "operationId": "update", "parameters": [ { "name": "couponListName", "in": "query", "description": "Current list name in the authenticated customer; case-insensitive.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Metadata changes. Omitted or null fields retain their current values.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CouponListUpdateSettings" } } }, "required": true, "x-bodyName": "body" }, "responses": { "204": { "description": "Coupon list metadata updated successfully; no response body.", "content": { "application/json": {} } }, "400": { "description": "InvalidParameterException / MISSING_PARAMETER: settings or couponListName is missing; INVALID_PARAMETER: lookup name length must be 3-50 characters, a supplied non-null name does not contain 3-50 alphanumeric characters, a supplied description or defaultText exceeds 500 characters, or previewText exceeds 200 characters; reminder settings are inconsistent, the threshold is negative, or the additional recipient is invalid or exceeds 200 characters.
NoSuchObjectException / NO_SUCH_OBJECT: no list with this name exists in the authenticated customer.
ObjectAlreadyExistsException / OBJECT_ALREADY_EXISTS: another list in this customer already uses the name, including archived lists; names are stored in lowercase.
UnexpectedErrorException / PERMISSION_DENIED: caller lacks edit access to this list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceExceptionBean" } } } }, "500": { "description": "UnexpectedErrorException / UNEXPECTED_ERROR: a backend operation failed; errorActor is SERVER.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceExceptionBean" } } } } } } } }, "components": { "schemas": { "CouponListUpdateSettings": { "type": "object", "properties": { "name": { "type": "string", "description": "List name: 3-50 alphanumeric characters, stored in lowercase. Optional new name; omitted or null retains the current name." }, "description": { "type": "string", "description": "Optional description, up to 500 characters. Empty clears it; omitted or null retains it." }, "previewText": { "type": "string", "description": "Placeholder used instead of a real coupon code in message previews; up to 200 characters. Empty resets to the list name followed by _previewCoupon; omitted or null retains it." }, "defaultText": { "type": "string", "description": "Fallback text used when no coupon code is available during sendout; up to 500 characters. Empty clears it; omitted or null retains it." }, "reminderEnabled": { "type": "boolean", "description": "False disables reminders and clears the threshold and additional recipient. True requires a supplied or existing threshold. Omitted or null preserves settings on update.", "default": false }, "remindThreshold": { "type": "integer", "description": "Non-negative available-code count at or below which the owner is reminded. Zero means remind when empty. Supplying it enables reminders; conflicts with reminderEnabled=false. Omitted or null preserves the threshold on update.", "format": "int64" }, "additionalReminderEmail": { "type": "string", "description": "Optional additional recipient: valid email, up to 200 characters. Requires enabled reminders. Empty clears it; omitted or null preserves it on update." } } }, "ServiceExceptionBean": { "type": "object", "properties": { "errorActor": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" } }, "xml": { "name": "ServiceException" } } } } } ````