Update Transactional Email Settings

PUT

https://api.bigcommerce.com/stores/:store_hash/v3/settings/email-statuses

PUT

/stores/:store_hash/v3/settings/email-statuses

curl -X PUT https://api.bigcommerce.com/stores/store_hash/v3/settings/email-statuses \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "abandoned_cart_email": true,
  "account_details_changed_email": true,
  "combined_order_status_email": true,
  "invoice_email": true,
  "product_review_email": false,
  "return_confirmation_email": true,
  "return_statuschange_email": true,
  "createaccount_email": true,
  "createguestaccount_email": true,
  "giftcertificate_email": true,
  "ordermessage_notification": true
}'

200Example

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

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

Authentication

X-Auth-Tokenstring

OAuth scopes

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

NOTE: Analytics endpoints require the Content (store_v2_content and store_v2_content_read_only) OAuth scope.

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

Request

This endpoint expects an object.

abandoned_cart_emailbooleanOptional

account_details_changed_emailbooleanOptional

combined_order_status_emailbooleanOptional

create_account_emailbooleanOptional

create_guest_account_emailbooleanOptional

gift_certificate_emailbooleanOptional

invoice_emailbooleanOptional

order_message_notification_emailbooleanOptional

product_review_emailbooleanOptional

return_confirmation_emailbooleanOptional

return_statuschange_emailbooleanOptional

Response

dataobjectOptional

metaobjectOptional

Response metadata.