PUT | /api/collections/{CollectionGuid}/settings/{Name} | Update setting value for selected collection | The setting is identified by its public name. The setting value associated with the selected collection is updated. The value is serialized. SuperUsers can update any Collection settings. Partners can update a setting owned by one of their Resellers Collections. Resellers can update settings for Collections they own. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CollectionGuid | path | Guid | Yes | |
Name | path | String | Yes | |
Value | body | String | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No |
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /api/collections/{CollectionGuid}/settings/{Name} HTTP/1.1
Host: api.secure-messaging.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{
"collectionGuid": "00000000000000000000000000000000",
"name": "String",
"value": "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" } } }