---
title: "Update Settings"
method: PATCH
path: "/sites/multiscreen/{site_name}/ecommerce"
---

# Update Settings

`PATCH /sites/multiscreen/{site_name}/ecommerce`

## Path parameters

- `site_name` string, required

## Request body

- object
  - `business_address` object
    - `address_1` string, required — Number and Street, concatenated
    - `address_2` string — Address complement (apt #, office #, floor level, etc.)
    - `city` string, required — City name
    - `country` string, required — ISO 3166 2-letters ISO country code. Ref: https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes
    - `phone` string — Phone number
    - `postal_code` string — Postal code
    - `region` string — The administrative region (depending on country, this can be a state, province, department, etc.)
    - `sub_locality` string — Sub-locality attached to the address (ex: county or district name).
  - `business_name` string
  - `cart_settings` object
    - `custom_fields` object — Record of custom field location <> array of custom fields. Possible zone values in the record: CONTACT_INFO, SHIPPING_ADDRESS, SHIPPING_METHODS, BILLING_ADDRESS, PAYMENT_METHODS Note that we enforce a maximum of 5 custom field per zone the update call will 400 if any zone exceed this limit. Note that the order of the fields in each zone’s array will dictate its display order in the checkout.
      - `CONTACT_INFO` object — Can also be SHIPPING_ADDRESS, SHIPPING_METHODS, BILLING_ADDRESS, PAYMENT_METHODS
        - `id` string — Unique identifier of the custom zone, auto-generated by us, and useful to track the setting to it’s equivalent in orders and carts. Optional will be auto-generated when not provided. Will 404 if provided and not found in the list of existing custom fields
        - `label` string, required — Label displayed alongside the input in the checkout inputs, emails, and in the merchant dashboard. Max value of 500 chars.
        - `options` string[] — Array of pre-defined string options for fields of type RADIO_LIST and SELECT. All options in the array must be unique, required when type RADIO_LIST or SELECT. Always empty for the other types, max of 500 options if the type is SELECT and max of 5 options if the type is RADIO_LIST
        - `placeholder` string — Visible placeholder value in the input field, to help customers with an example value expected my the merchants. Note that this parameter is not supported for custom fields of type RADIO_LIST and CHECKBOX. The update call will 400 if a value is passed for those types. Max value of 200 chars
        - `required` boolean — Bool to set the custom field as required in the checkout. If this is set to true, customers will face validation errors if they leave the custom field empty.
        - `type` string, required — Input type of the custom fields. Possible input types are: TEXT, TEXTAREA, SELECT, RADIO_LIST, CHECKBOX, DATE
        - `includes_time` boolean — When true, the date custom field stores a timestamp; when false, date-only. Required in settings request when type is DATE. Only allowed when type is DATE.
        - `date_range_policy` 'ANY' | 'PAST_ONLY' | 'FUTURE_ONLY' — Range policy for date custom fields. Required in settings request when type is DATE. Only allowed when type DATE
    - `display_instruction_field` boolean — Should the cart display an instruction field.
    - `display_phone_field` boolean — Should the cart display a phone field.
    - `marketing_opt_in_settings` object
      - `description_markup` string — Optional string of HTML to replace the default label we have in place. All CSS and potential tags that can cause XSS attacks are completely removed when setting this value. The only tags supported are: p, a, em, i, strong, u, br
      - `is_enabled` boolean, required — Simple boolean to display or not the checkbox at checkout.
    - `split_address_1_field` boolean — Should addresses associated with the cart be split into street number and street name fields.
    - `split_name_field` boolean — Should the full name of the cart owner be split into first and last name fields.
    - `terms_and_conditions_html` string — Enables a checkbox with the accompanying passed string in the checkout cart.
  - `contact_email` string
  - `contact_name` string
  - `default_currency` string
  - `enabled_countries` string[]
  - `measurement_system` 'IMPERIAL' | 'METRIC'
  - `send_email_notifications` boolean
  - `show_lowest_price` boolean
  - `tax_settings` object — The tax settings of the store.
    - `calculation_mode` string — [TAXES_INCLUDED_IN_PRICE, TAXES_EXCLUDED_FROM_PRICE] Value to set how we will calculate taxes on a cart/order.
    - `default_tax_zone_id` string — Tax zone to apply the "estimated taxes" and the taxes included in prices.

## Response `200`

200

- object
  - `business_address` object
    - `address_1` string
    - `address_2` string
    - `city` string
    - `country` string
    - `phone` string
    - `postal_code` string
    - `region` string
    - `sub_locality` string
  - `business_name` string
  - `cart_settings` object
    - `display_instruction_field` boolean
    - `display_phone_field` boolean
    - `marketing_opt_in_settings` object
      - `description_markup` string
      - `is_enabled` boolean
    - `split_address_1_field` boolean
    - `split_name_field` boolean
    - `terms_and_conditions_html` string
  - `contact_email` string
  - `contact_name` string
  - `default_currency` string
  - `enabled_countries` string[]
  - `send_email_notifications` boolean
  - `show_lowest_price` boolean
  - `tax_settings` object
    - `calculation_mode` string
    - `default_tax_zone_id` string
  - `time_zone` string

## Other responses

- `400` — 400
- `401` — 401
- `403` — 403
- `404` — 404

---

[API](https://skmtc.net/duda/apis/partner-api.md) · [All operations](https://skmtc.net/duda/apis/partner-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/duda/partner-api/versions/5b9208270ed1/schema)