Update Channel Order Settings

PUT

https://api.bigcommerce.com/stores/:store_hash/v3/orders/settings/channels/:channel_id

PUT

/stores/:store_hash/v3/orders/settings/channels/:channel_id

curl -X PUT https://api.bigcommerce.com/stores/store_hash/v3/orders/settings/channels/channel_id \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "notifications": {
    "order_placed": {
      "email_addresses": [
        "admin@example.com",
        "another-email@example.com"
      ]
    },
    "forward_invoice": {
      "email_addresses": []
    }
  }
}'

{
  "notifications": {
    "order_placed": {
      "email_addresses": [
        "string"
      ]
    },
    "forward_invoice": {
      "email_addresses": [
        "string"
      ]
    }
  },
  "meta": {}
}

Updates order settings for a specific channel.

Note: You must override both notifications email_addresses or neither, i.e. either both notification email_addresses are an array of valid email addresses, or both email_addresses must be null. You may not have one set to an array of addresses and the other set to null.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Order Transactions	read and modify `transactions` and `payment_methods`	`store_v2_transactions`
Order Transactions	read `transactions` and `payment_methods`	`store_v2_transactions_read_only`
Orders	read and modify `payment_methods`	`store_v2_orders`
Orders	read `payment_methods`	`store_v2_orders_read_only`

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

channel_idstringRequired

Channel ID

store_hashstringRequired

Permanent ID of the BigCommerce store.

Request

This endpoint expects an object.

notificationsobjectOptional

Channel notification settings.

Response

notificationsobjectOptional

Channel notification settings.

metaobjectOptional

Response metadata.

Errors

400

Bad Request Error

422

Unprocessable Entity Error