Create Abandoned Cart Email Template

POST

https://api.bigcommerce.com/stores/:store_hash/v3/marketing/abandoned-cart-emails

POST

/stores/:store_hash/v3/marketing/abandoned-cart-emails

curl -X POST https://api.bigcommerce.com/stores/store_hash/v3/marketing/abandoned-cart-emails \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "is_active": true,
  "coupon_code": "FF11-22X4",
  "notify_at_minutes": 60,
  "template": {
    "subject": "Complete your purchase at {{ store.name }}",
    "body": "{{lang '\''hello_phrase'\'' }}<br>Complete your purchase <a href='\''{{ notification.checkout_link }}'\''>{{notification.checkout.link}}",
    "translations": [
      {
        "locale": "en",
        "keys": {
          "hello_phrase": "Welcome"
        }
      }
    ]
  }
}'

{
  "data": {
    "id": 1,
    "notify_at_minutes": 60,
    "coupon_code": "FF11-22X4",
    "template": {
      "subject": "'Complete your purchase at {{ store.name }}'",
      "body": "'Complete your purchase <a href=\"{{ notification.checkout_link }}\">{{notification.checkout.link}}'",
      "translations": [
        {
          "locale": "en",
          "keys": {}
        }
      ]
    },
    "is_active": true,
    "sent_num": 1
  },
  "meta": {}
}

Create an Abandoned Cart Email template.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Information & Settings	read-only	`store_v2_information_read_only`
Information & Settings	modify	`store_v2_information`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

Path parameters

store_hashstringRequired

Permanent ID of the BigCommerce store.

Query parameters

channel_idintegerOptional

Channel ID to use for channel-level data.

Request

This endpoint expects an object.

is_activebooleanOptional

coupon_codestringOptional

notify_at_minutesenumOptional

Describes when this email will be sent, in minutes. Only supports certain intervals described in the enum.

templateobjectOptional

Response

dataobjectOptional

metaobjectOptional

Response metadata.

Errors

422

Unprocessable Entity Error