Get Transactional Email Settings
GET /stores/{store_hash}/v3/settings/email-statuses
Request
Get global transactional email settings or channel specific overrides by channel_id.
Authentication
- X-Auth-Token in header - required
Parameters
- store_hash in path - string
- channel_id in query - integer
Channel ID to use for channel-specific setting. If omitted, you will interact with the global setting 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: xxxxxxxxxxxxxxxxx'
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
dataobject
metaobject
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 /stores/{store_hash}/v3/settings/email-statuses
Request
Update global transactional email settings or create channel specific overrides by channel_id.
Authentication
- X-Auth-Token in header - required
Parameters
- store_hash in path - string
- 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 setting. If omitted, you will interact with the global setting only.
Body
object | application/json
abandoned_cart_emailboolean
account_details_changed_emailboolean
combined_order_status_emailboolean
create_account_emailboolean
create_guest_account_emailboolean
gift_certificate_emailboolean
invoice_emailboolean
order_message_notification_emailboolean
product_review_emailboolean
return_confirmation_emailboolean
return_statuschange_emailboolean
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
dataobject
metaobject
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": {} }