| PUT | /api/collections/{CollectionGuid} | Update an existing collection. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CollectionGuid | path | Guid | Yes | |
| SiteGuid | body | Guid | No | |
| SiteEndpointGuid | body | Guid | No | |
| Name | body | String | No | The name of the new collection. Only allowed to be set by SuperUsers. |
| Status | body | String | No | Status of the collection. Only allowed to be set by SuperUsers.Allowable Values
|
| ServicesApiBaseUrl | body | String | No | The base URL where this collection can be reached at. |
| CurrentVersion | body | String | No | Current Version of the collection. Only allowed to be set by SuperUsers. |
| DefaultTrialPeriod | body | Integer | No | Default Trial Period (in days) of the collection. Only allowed to be set by SuperUsers. |
| 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} HTTP/1.1
Host: api.secure-messaging.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{
"collectionGuid": "00000000000000000000000000000000",
"siteGuid": "00000000000000000000000000000000",
"siteEndpointGuid": "00000000000000000000000000000000",
"name": "String",
"status": "String",
"servicesApiBaseUrl": "String",
"currentVersion": "String",
"defaultTrialPeriod": 0
}
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"
}
}
}