PUT Api/v{apiVersion}/Settings/{id}

Updates an setting

Request Information

URI Parameters

Name	Description	Type	Additional information
id		globally unique identifier	Required
apiVersion		string	None.

Body Parameters

SettingValues

Name	Description	Type	Additional information
Value		string	None.
Notes		string	None.

Request Formats

application/json, text/json

Sample:

{
  "Value": "sample string 1",
  "Notes": "sample string 2"
}

application/xml, text/xml

Sample:

<SettingValues xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hier.Api.ViewModels">
  <Notes>sample string 2</Notes>
  <Value>sample string 1</Value>
</SettingValues>

application/x-www-form-urlencoded

Sample:

Sample not available.

multipart/form-data

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Value"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Notes"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

Resource Description

SettingDetails

Name	Type	Additional information
SettingID	globally unique identifier	None.
Key	string	None.
Value	string	None.
ValueType	SettingValueType	None.
Operator	OperatorPreview	None.
Notes	string	None.
CreatedAt	date	None.
CreatedBy	string	None.
ModifiedAt	date	None.
ModifiedBy	string	None.

Response Formats

application/json, text/json

Sample:

{
  "SettingID": "1b8f98f6-9e6c-4b55-8488-8c1731ccfd14",
  "Key": "sample string 2",
  "Value": "sample string 3",
  "ValueType": "String",
  "Operator": {
    "OperatorID": "5c6a711a-3d0f-4727-b4fc-9676ce0c5e8d",
    "ParentName": "sample string 2",
    "Name": "sample string 3",
    "Status": "InActive",
    "Address": "sample string 4",
    "Postcode": "sample string 5",
    "City": {
      "AreaID": "8c018bea-c9de-44ec-9ae8-a51b186bd067",
      "ParentID": "59a239c7-0d96-43a4-81fa-f0ef095fd7bf",
      "ParentName": "sample string 2",
      "SupplierName": "sample string 3",
      "CustomerName": "sample string 4",
      "StoreName": "sample string 5",
      "Code": "sample string 6",
      "Name": "sample string 7",
      "Type": "Neighbourhood",
      "Status": "InActive",
      "OwnerName": "sample string 8",
      "Population": 9,
      "Mailboxes": 10
    },
    "PhoneNumber": "sample string 6",
    "EmailAddress": "sample string 7"
  },
  "Notes": "sample string 4",
  "CreatedAt": "2026-01-15T14:14:17.660322Z",
  "CreatedBy": "sample string 6",
  "ModifiedAt": "2026-01-15T14:14:17.660322Z",
  "ModifiedBy": "sample string 8"
}

application/xml, text/xml

Sample:

<SettingDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hier.Api.ViewModels">
  <CreatedAt>2026-01-15T15:14:17.660322+01:00</CreatedAt>
  <CreatedBy>sample string 6</CreatedBy>
  <Key>sample string 2</Key>
  <ModifiedAt>2026-01-15T15:14:17.660322+01:00</ModifiedAt>
  <ModifiedBy>sample string 8</ModifiedBy>
  <Notes>sample string 4</Notes>
  <Operator>
    <Address>sample string 4</Address>
    <City>
      <AreaID>8c018bea-c9de-44ec-9ae8-a51b186bd067</AreaID>
      <Code>sample string 6</Code>
      <CustomerName>sample string 4</CustomerName>
      <Mailboxes>10</Mailboxes>
      <Name>sample string 7</Name>
      <OwnerName>sample string 8</OwnerName>
      <ParentID>59a239c7-0d96-43a4-81fa-f0ef095fd7bf</ParentID>
      <ParentName>sample string 2</ParentName>
      <Population>9</Population>
      <Status>InActive</Status>
      <StoreName>sample string 5</StoreName>
      <SupplierName>sample string 3</SupplierName>
      <Type>Neighbourhood</Type>
    </City>
    <EmailAddress>sample string 7</EmailAddress>
    <Name>sample string 3</Name>
    <OperatorID>5c6a711a-3d0f-4727-b4fc-9676ce0c5e8d</OperatorID>
    <ParentName>sample string 2</ParentName>
    <PhoneNumber>sample string 6</PhoneNumber>
    <Postcode>sample string 5</Postcode>
    <Status>InActive</Status>
  </Operator>
  <SettingID>1b8f98f6-9e6c-4b55-8488-8c1731ccfd14</SettingID>
  <Value>sample string 3</Value>
  <ValueType>String</ValueType>
</SettingDetails>

multipart/form-data

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SettingID"

1b8f98f6-9e6c-4b55-8488-8c1731ccfd14
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Key"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Value"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ValueType"

String
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Operator.OperatorID"

5c6a711a-3d0f-4727-b4fc-9676ce0c5e8d
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Operator.ParentName"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Operator.Name"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Operator.Status"

InActive
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Operator.Address"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Operator.Postcode"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Operator.City.AreaID"

8c018bea-c9de-44ec-9ae8-a51b186bd067
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Operator.City.ParentID"

59a239c7-0d96-43a4-81fa-f0ef095fd7bf
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Operator.City.ParentName"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Operator.City.SupplierName"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Operator.City.CustomerName"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Operator.City.StoreName"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Operator.City.Code"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Operator.City.Name"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Operator.City.Type"

Neighbourhood
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Operator.City.Status"

InActive
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Operator.City.OwnerName"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Operator.City.Population"

9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Operator.City.Mailboxes"

10
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Operator.PhoneNumber"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Operator.EmailAddress"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Notes"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CreatedAt"

2026-01-15T15:14:17.6603220+01:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CreatedBy"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ModifiedAt"

2026-01-15T15:14:17.6603220+01:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ModifiedBy"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e--