Email Statuses
Get Transactional Email Settings
GET https://api.bigcommerce.com/stores/{store_hash}/v3/settings/email-statusesRequest
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 - stringrequiredThe MIME type of the response body.
- channel_id in query - integerChannel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.
example
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
Example
Update Transactional Email Settings
PUT https://api.bigcommerce.com/stores/{store_hash}/v3/settings/email-statusesRequest
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 - stringrequiredThe MIME type of the response body.
- Content-Type in header with default of application/json - stringrequiredThe MIME type of the request body.
- channel_id in query - integerChannel ID to use for channel-specific settings. If omitted, you will interact with the global settings 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
product_review_emailboolean
return_confirmation_emailboolean
return_statuschange_emailboolean
Example
Response
OK
Body
object | application/json
dataobject
Example
Did you find what you were looking for?