Docs
Content API
Abandoned cart emails
Template Settings

Template settings

Get email template settings

GET /marketing/abandoned-cart-emails/settings

Request

Read Abandoned Cart Email Template settings.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • channel_id in query - integer
    required
    Channel ID to use for channel-specific settings.

example

curl --request GET \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/marketing/abandoned-cart-emails/settings' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'

Response

OK

Body

object | application/json

  • use_global    boolean
    required

    Boolean value that specifies the inheritance state.

example

{
"use_global": true
}

Update email template settings

PUT /marketing/abandoned-cart-emails/settings

Request

Update Abandoned Cart Email template settings.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • channel_id in query - integer
    Channel ID to use for channel-level data.
  • Content-Type in header with default of application/json - string
    required
    The MIME type of the request body.

Body

object | application/json

  • use_global    boolean
    required

    Boolean value that specifies the inheritance state.

example

{
"use_global": true
}

Response

OK

Body

object | application/json

  • use_global    boolean
    required

    Boolean value that specifies the inheritance state.

example

{
"use_global": true
}
Did you find what you were looking for?
Get default email templateGet email template settings