Method description
Update an existing existent equalize setting for the required client {instance_id}.
URI Parameters
None
Request Data
...
Requests
Body
application/json
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"enabled": false,
} |
See Play Service models for for details. The request may include only the fields that are to be updated.
To remove a field (and set the default) set it to null. It is an error to remove a required field.
Example to enable an equalize setting:
| Code Block | ||
|---|---|---|
| ||
{
"enabled": true
} |
Response format and codes
...
Responses
201 - item has been updated
...
The response will contain the updated equalize data.
...
Type: application/json
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"id": 1461321668,
"title": "DefaultMy Custom Config",
"enabled": truefalse,
"created_on": "2017-04-24T10:28:37",
"updated_on": "2017-04-24T10:28:37",
"fields": [
{"field": "title", "boost": 5080},
{"field": "description", "boost": 25}
]
20} |
Also, a Location header will point to the URL for the boost that was just created.
400 - Invalid parameters. Error response will include details
Type: application/json
| Code Block | ||||
|---|---|---|---|---|
| ||||
{ "code": "validation_error", "details": [ {"field "message": "price", "boost": 10} ] }1 is not of type 'boolean'", "path": ".enabled" } ], "message": "Error validating JSON", "status": "error" } |
401 - the user performing the action doesn't meet the security criteria
Type: application/json
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"code": 401,
"details": "The server could not verify that you are authorized to access the URL requested. You either supplied the wrong credentials (e.g. a bad password), or your browser doesn't understand how to supply the credentials required.",
"message": "Unauthorized",
"status": "error"
} |
404 - the instance or item doesn't exist
Type: application/json
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"code": 404,
"details": "Invalid id '123456'",
"message": "Not Found",
"status": "error"
} |