Method description
Update an existing existent boost for the requested client {instance_id}.
URI Parameters
None
Request Data
...
Requests
Body
application/json
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"enabled": true,
} |
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 disable a boost:
| Code Block | ||
|---|---|---|
| ||
{
"enabled": false
} |
Response format and codes
...
Responses
201 - item has been created
Type: application/json
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"activation_date": "2016-10-25T22:00:00",
"created_on": "2017-08-08T15:27:52",
"deactivation_date": "2017-04-25T22:00:00",
"enabled": true,
"extra": {
"user": "-"
},
"id": "5989d878e6ece90011a9276c",
"keywords": [
"ring"
],
"langs": [
"en"
],
"references": [
{
"ref": "19430508",
"title": "Eternity Ring"
}
],
"updated_on": "2017-08-08T15:27:52",
"zero_results": false
} |
Also, a Location header will point to the URL for the boost that was just created.
400 - Invalid parameters. Error response will include details
...
The response will contain the updated boost data.
...
Type: application/json
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"_idcode": ObjectId()"validation_error",
"enableddetails": false,[
"zero_results": false, {
"references": [ {"refmessage": "SKU12341234", "title1 is not of type 'boolean'",
"path": "..."enabled"
}
],
"keywordsmessage": ["blueError validating trousersJSON"],
"activation_datestatus": null, "error"
} |
401 - the user performing the action doesn't meet the security criteria
Type: application/json
| Code Block | ||||
|---|---|---|---|---|
| ||||
{ "deactivation_datecode": null401, "langsdetails": ["en_US", "en_GB"]"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", "extrastatus": {},"error" } |