--- title: Update Coupon slug: api-documentation/update-coupon docTags: createdAt: 2026-08-27T17:06:56.421Z --- { "id": "E-44ydqmuG9LxIiC_6VQd", "type": "api-oas-v2", "data": { "method": "PUT", "url": "https://api.upstartcommerce.com/v1/promotion/coupon/{id}", "servers": [ { "url": "https://api.upstartcommerce.com/v1/promotion/coupon/{id}" } ], "name": "Update Coupon", "description": "

This endpoint allows administrators to update an existing coupon.

\n

Authorized permissions:

\n", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "id", "type": "array", "description": "

Unique identifier for coupon (coupon code).

", "schema": [], "itemType": "string", "customType": "string[]" } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" }, { "kind": "required", "name": "x-upstart-tenant", "type": "string", "description": "Tenant identifier associated with the site this call is for." } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "The request body must include coupon usages with corresponding site ids that are linked to existing coupons.", "customType": "UpdateCouponRequest", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for coupon." }, { "name": "couponUsages", "kind": "required", "type": "array", "description": "", "modelRef": "#/components/schemas/CouponUsage", "customType": "CouponUsage[]", "schema": [ { "name": "siteIds", "kind": "required", "type": "array", "description": "Unique identifier for tenant's sites.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "maxUserUsage", "kind": "optional", "type": "integer", "description": "" }, { "name": "maxUsage", "kind": "optional", "type": "integer", "description": "" } ] } ], "modelRef": "#/components/schemas/UpdateCouponRequest", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "NoChannelPortalAccess", "name": "NoChannelPortalAccess", "kind": "optional", "type": "http", "description": "

This authentication is required for clients to interact with any of the management APIs. Similar to 'LoggedIn', it indicates that the user has actually logged into the system, but in this case with a management role.

", "scheme": "bearer" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "

Success-coupon updated successfully.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "UpdateCouponRequest", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for coupon." }, { "name": "couponUsages", "kind": "required", "type": "array", "description": "", "modelRef": "#/components/schemas/CouponUsage", "customType": "CouponUsage[]", "schema": [ { "name": "siteIds", "kind": "required", "type": "array", "description": "Unique identifier for tenant's sites.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "maxUserUsage", "kind": "optional", "type": "integer", "description": "" }, { "name": "maxUsage", "kind": "optional", "type": "integer", "description": "" } ] } ], "modelRef": "#/components/schemas/UpdateCouponRequest", "isExpanded": true } ] }, { "statusCode": "400", "description": "The request contained information that the server was unable to process. Appropriate errors are provided in the response body.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ValidationErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ValidationErrorResponse", "isExpanded": true } ] }, { "statusCode": "401", "description": "The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "required", "type": "string", "description": "" }, { "name": "reason", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "403", "description": "

An update to this resource requires the if-match and if-unmodified-since headers to be sent in order to process the request.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "required", "type": "string", "description": "" }, { "name": "reason", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "404", "description": "The requested resource was not found in the NoChannel system.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "required", "type": "string", "description": "" }, { "name": "reason", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "sNVNll0a86C9gyt4Y50IR", "language": "curl", "label": "cURL", "code": "curl --request PUT \\\n --url https://api.upstartcommerce.com/v1/promotion/coupon/{id} \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --header 'x-upstart-tenant: string' \\\n --data '{\n \"id\": \"\",\n \"couponUsages\": [\n {\n \"siteIds\": []\n }\n ]\n }'" }, { "id": "tSTh5lroIDaNoUsbHIgqu", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"x-upstart-tenant\", \"string\");\n\nvar raw = JSON.stringify({\n \"id\": \"\",\n \"couponUsages\": [\n {\n \"siteIds\": []\n }\n ]\n});\n\nvar requestOptions = {\n method: 'PUT',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.upstartcommerce.com/v1/promotion/coupon/{id}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "JA9QYMKjPig0Yysl7vQkk", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.upstartcommerce.com/v1/promotion/coupon/{id}\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Put.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"x-upstart-tenant\"] = \"string\"\nrequest.body = JSON.dump({\n \"id\": \"\",\n \"couponUsages\": [\n {\n \"siteIds\": []\n }\n ]\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "-T4LRXzr1y92CMwER94ma", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.upstartcommerce.com/v1/promotion/coupon/{id}\"\n\npayload = json.dumps({\n \"id\": \"\",\n \"couponUsages\": [\n {\n \"siteIds\": []\n }\n ]\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'x-upstart-tenant': 'string'\n}\n\nresponse = requests.request(\"PUT\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "sNVNll0a86C9gyt4Y50IR" }, "results": { "languages": [ { "id": "WpvDXSiFBNt74flQdNuK5", "language": "200", "code": "// Success-coupon updated successfully.\n{\n \"id\": \"\",\n \"couponUsages\": [\n {\n \"siteIds\": [\n \"\"\n ],\n \"maxUserUsage\": 0,\n \"maxUsage\": 0\n }\n ]\n}" }, { "id": "1MdIF2a5A-nwysuZTJSz5", "language": "400", "code": "// The request contained information that the server was unable to process. Appropriate errors are provided in the response body.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\"\n}" }, { "id": "IyZqgQrImUuZZlSFXPjHa", "language": "401", "code": "// The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" }, { "id": "Dp3y6jZzkR5TJT6aJAKF0", "language": "403", "code": "// An update to this resource requires the if-match and if-unmodified-since headers to be sent in order to process the request.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" }, { "id": "B4xoJWaDJXqrc9EDvlAY1", "language": "404", "code": "// The requested resource was not found in the NoChannel system.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" } ], "selectedLanguageId": "WpvDXSiFBNt74flQdNuK5" } }, "children": [ { "text": "" } ] }