> ## 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. # Check a coupon code's status > Returns FREE, LOCKED or NOT_FOUND only. The request identifies the list by couponListName within the authenticated customer. The supplied code is never returned. This operation does not reserve or consume a code. ## OpenAPI ````json POST /couponList/checkCodeStatus { "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/checkCodeStatus": { "post": { "tags": [ "Coupon" ], "summary": "Check a coupon code's status", "description": "Returns FREE, LOCKED or NOT_FOUND only. The request identifies the list by couponListName within the authenticated customer. The supplied code is never returned. This operation does not reserve or consume a code. ", "operationId": "checkCodeStatus", "requestBody": { "description": "List and coupon code to check.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CouponCodeStatusBody" } } }, "required": true, "x-bodyName": "body" }, "responses": { "200": { "description": "FREE, LOCKED or NOT_FOUND.", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "InvalidParameterException / INVALID_PARAMETER: request body is missing, code is null or blank, code exceeds 200 characters, or couponListName length is outside 3-50 characters; MISSING_PARAMETER: couponListName is omitted.
NoSuchObjectException / NO_SUCH_OBJECT: no list with this name exists in the authenticated customer. An absent code in an accessible list returns the successful status NOT_FOUND instead.
UnexpectedErrorException / PERMISSION_DENIED: caller lacks read access to this list. Errors never include the submitted coupon code.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceExceptionBean" } } } }, "500": { "description": "UnexpectedErrorException / UNEXPECTED_ERROR: a backend operation failed; errorActor is SERVER. Errors never include the submitted coupon code.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceExceptionBean" } } } } } } } }, "components": { "schemas": { "CouponCodeStatusBody": { "required": [ "code", "couponListName" ], "type": "object", "properties": { "couponListName": { "type": "string", "description": "List name in the authenticated customer; case-insensitive, 3-50 characters." }, "code": { "type": "string", "description": "Coupon code to look up; non-blank, at most 200 characters. Never returned in responses or errors." } } }, "ServiceExceptionBean": { "type": "object", "properties": { "errorActor": { "type": "string" }, "errorCode": { "type": "string" }, "message": { "type": "string" } }, "xml": { "name": "ServiceException" } } } } } ````