Docs
Management API
Settings
Email Statuses

Email Statuses

Get Transactional Email Settings

GET /settings/email-statuses

Request

Get global transactional email settings or channel specific overrides by channel_id.

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-specific settings. If omitted, you will interact with the global settings only.

example

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

Response

OK, null indicates that a particular field has not been overridden on a channel level when channel level settings are requested

Body

object | application/json

  • data    object

  • meta    object

    Response metadata.

Example

{
"data": {
"abandoned_cart_email": true,
"account_details_changed_email": true,
"combined_order_status_email": true,
"createaccount_email": true,
"createguestaccount_email": true,
"giftcertificate_email": true,
"invoice_email": true,
"ordermessage_notification": true,
"product_review_email": false,
"return_confirmation_email": true,
"return_statuschange_email": true
},
"meta": {}
}

Update Transactional Email Settings

PUT /settings/email-statuses

Request

Update global transactional email settings or create channel specific overrides by channel_id.

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.
  • Content-Type in header with default of application/json - string
    required
    The MIME type of the request body.
  • channel_id in query - integer
    Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.

Body

object | application/json

  • abandoned_cart_email    boolean

  • combined_order_status_email    boolean

  • gift_certificate_email    boolean

  • invoice_email    boolean

  • order_message_notification_email    boolean

  • product_review_email    boolean

  • return_confirmation_email    boolean

  • return_statuschange_email    boolean

Example

{
"abandoned_cart_email": true,
"account_details_changed_email": true,
"combined_order_status_email": true,
"createaccount_email": true,
"createguestaccount_email": true,
"giftcertificate_email": true,
"invoice_email": true,
"ordermessage_notification": true,
"product_review_email": false,
"return_confirmation_email": true,
"return_statuschange_email": true
}

Response

OK

Body

object | application/json

  • data    object

  • meta    object

    Response metadata.

Example

{
"data": {
"abandoned_cart_email": true,
"account_details_changed_email": true,
"combined_order_status_email": true,
"createaccount_email": true,
"createguestaccount_email": true,
"giftcertificate_email": true,
"invoice_email": true,
"ordermessage_notification": true,
"product_review_email": false,
"return_confirmation_email": true,
"return_statuschange_email": true
},
"meta": {}
}
Did you find what you were looking for?
Update Catalog SettingsGet Transactional Email Settings