DEVDOCS-5483 [new]: Settings API, add channel_id query parameter to l…

…ocale settings (#1487)
bigcommerce · Oct 6, 2023 · 4852133 · 4852133
1 parent 8b28420
commit 4852133
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/reference/settings.v3.yml b/reference/settings.v3.yml
@@ -783,6 +783,7 @@ paths:
   '/settings/store/locale':
     parameters:
       - $ref: '#/components/parameters/Accept'
+      - $ref: '#/components/parameters/ChannelIdParam'
     get:
       summary: Get Locale Settings
       description: Returns global locale settings.
@@ -810,7 +811,10 @@ paths:
         - Store Locale
     put:
       summary: Update Locale Settings
-      description: Updates global locale settings.
+      description: |-
+        Updates global locale settings.
+
+        Set a channel override by using the `channel_id` query parameter. To remove a channel override, set `null` for a field. The field then inherits the global value.
       parameters:
         - $ref: '#/components/parameters/ContentType'
       requestBody: