CCC API v8.12.0.0

<back to all web services

UpdateSettingKey

The following routes are available for this service:
PUT/api/settings/keysUpdate setting key
UpdateSettingKey Parameters:
NameParameterData TypeRequiredDescription
KeyGuidbodyGuidNo
NamebodyStringNo
AccessTypebodyStringNo

Allowable Values

  • Service
  • Collection
  • Reseller
  • Partner
GroupGuidbodyGuidNo
VisibilitybodyStringNo

Allowable Values

  • Private
  • Protected
  • Public
DescriptionbodyStringNo
ValidationDescriptionbodyStringNo
LabelbodyStringNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /api/settings/keys HTTP/1.1 
Host: api.secure-messaging.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{
  "keyGuid": "00000000000000000000000000000000",
  "name": "String",
  "accessType": "String",
  "groupGuid": "00000000000000000000000000000000",
  "visibility": "String",
  "description": "String",
  "validationDescription": "String",
  "label": "String"
}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{
  "responseStatus": {
    "errorCode": "String",
    "message": "String",
    "stackTrace": "String",
    "errors": [
      {
        "errorCode": "String",
        "fieldName": "String",
        "message": "String",
        "meta": {
          "String": "String"
        }
      }
    ],
    "meta": {
      "String": "String"
    }
  }
}