Create or update coupon
Creates a new single coupon or updates an existing coupon.
To update an existing coupon, first make a Get coupon by coupon code request, copy the response body and apply the desired changes. Then, use the complete edited body as a request body in this update call.
⚠️ When updating a coupon, don't change the original couponCode, or a new coupon will be created instead of the existing coupon being updated.
Permissions
Any user or API key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:
| Product | Category | Resource |
|---|---|---|
| Rates and Benefits | Promotions | Manage benefits and rates |
There are no applicable predefined roles for this resource list. You must create a custom role and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see Authentication overview.
❗ To prevent integrations from having excessive permissions, consider the best practices for managing API keys when assigning License Manager roles to integrations.
Headers
Type of the content being sent.
HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.
Request body
Example request
{
"utmSource": "email",
"utmCampaign": "summer",
"couponCode": "summersale10",
"maxItemsPerClient": 10,
"expirationIntervalPerUse": "00:00:00",
"maxUsage": 1
}Response
OK