PUT v1/company/settings/{id}

Use this method to update the value of a specific setting. It can also be used to update the display name or system id of a setting optionally where if these attributes are not found, or empty, they will not be updated. Make sure you always send a value for "value" as this property will always be updated even when not present which will be the equivalent to been (NULL).

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Setting Id

 string

Required

Body Parameters

Structure representing what needs be changed on a setting.

Setting
NameDescriptionTypeAdditional information
systemId

Setting internal identifier, most systems using

 string

None.
group

Property group, note that not all settings storage like company settings support groups yet. Groups are available for Applications, Properties and Users only.

 string

None.
id

Setting unique identifier.

 string

None.
name

Setting display name.

 string

None.
value

Setting value stored.

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "systemId": "sample string 1",
  "group": "sample string 2",
  "id": "sample string 3",
  "name": "sample string 4",
  "value": "sample string 5"
}

Response Information

Resource Description

Returns appropriate http status code of OK if all validation and updating occurred without errors.

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.