Add promo code

POST

https://api.mailchimp.com/3.0/ecommerce/stores/:store_id/promo-rules/:promo_rule_id/promo-codes

POST

/3.0/ecommerce/stores/:store_id/promo-rules/:promo_rule_id/promo-codes

curl -X POST https://api.mailchimp.com/3.0/ecommerce/stores/store_id/promo-rules/promo_rule_id/promo-codes \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "code": "summersale",
  "id": "string",
  "redemption_url": "A url that applies promo code directly at checkout or a url that points to sale page or store url"
}'

200Successful

{
  "_links": [
    {
      "href": "string",
      "method": "GET",
      "rel": "string",
      "schema": "string",
      "targetSchema": "string"
    }
  ],
  "code": "summersale",
  "created_at_foreign": "2024-01-15T09:30:00Z",
  "enabled": "true",
  "id": "string",
  "redemption_url": "A url that applies promo code directly at checkout or a url that points to sale page or store url",
  "updated_at_foreign": "2024-01-15T09:30:00Z",
  "usage_count": 1
}

Add a new promo code to a store.

Authentication

AuthorizationBearer

Authorization using a Mailchimp API key (a.k.a. Bearer token)

AuthorizationBearer

Authorization using OAuth

Path parameters

store_idstringRequired

The store id.

promo_rule_idstringRequired

The id for the promo rule of a store.

Request

Information about an Ecommerce Store's specific Promo Code.

codestringRequired

The discount code. Restricted to UTF-8 characters with max length 50.

idstringRequiredformat: "\S"1-50 characters

A unique identifier for the promo code. Restricted to UTF-8 characters with max length 50.

redemption_urlstringRequired

The url that should be used in the promotion campaign restricted to UTF-8 characters with max length 2000.

created_at_foreignstringOptional

The date and time the promotion was created in ISO 8601 format.

enabledbooleanOptional

Whether the promo code is currently enabled.

updated_at_foreignstringOptional

The date and time the promotion was updated in ISO 8601 format.

usage_countintegerOptional

Number of times promo code has been used.

Response

This endpoint returns an object.

_linkslist of objectsOptionalRead-only

A list of link types and descriptions for the API schema documents.

codestringOptional

The discount code. Restricted to UTF-8 characters with max length 50.

created_at_foreigndatetimeOptional

The date and time the promotion was created in ISO 8601 format.

enabledbooleanOptional

Whether the promo code is currently enabled.

idstringOptionalRead-only

A unique identifier for the promo Code.

redemption_urlstringOptional

The url that should be used in the promotion campaign restricted to UTF-8 characters with max length 2000.

updated_at_foreigndatetimeOptional

The date and time the promotion was updated in ISO 8601 format.

usage_countintegerOptional

Number of times promo code has been used.