PUT v1/Settings/Site

Update a site settings.

Request Information

URI Parameters

None.

Body Parameters

A list of site IDs and setting configurations to be applied.

InSiteUpdateSettings
NameDescriptionTypeAdditional information
SettingSet

List of SettingSets that each contain a configuration

Collection of SettingSet

None.

Request Formats

application/json, text/json

Sample:
{
  "SettingSet": [
    {
      "SiteId": "sample string 1",
      "SiteIdType": 0,
      "Settings": [
        {
          "SettingId": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "SettingId": "sample string 1",
          "Value": "sample string 2"
        }
      ]
    },
    {
      "SiteId": "sample string 1",
      "SiteIdType": 0,
      "Settings": [
        {
          "SettingId": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "SettingId": "sample string 1",
          "Value": "sample string 2"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:
<InSiteUpdateSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Admin.Inbound">
  <SettingSet>
    <SettingSet>
      <Settings>
        <Settings>
          <SettingId>sample string 1</SettingId>
          <Value>sample string 2</Value>
        </Settings>
        <Settings>
          <SettingId>sample string 1</SettingId>
          <Value>sample string 2</Value>
        </Settings>
      </Settings>
      <SiteId>sample string 1</SiteId>
      <SiteIdType>SiteId</SiteIdType>
    </SettingSet>
    <SettingSet>
      <Settings>
        <Settings>
          <SettingId>sample string 1</SettingId>
          <Value>sample string 2</Value>
        </Settings>
        <Settings>
          <SettingId>sample string 1</SettingId>
          <Value>sample string 2</Value>
        </Settings>
      </Settings>
      <SiteId>sample string 1</SiteId>
      <SiteIdType>SiteId</SiteIdType>
    </SettingSet>
  </SettingSet>
</InSiteUpdateSettings>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.