Method description
Update an existing boost for the requested instance.
URI Parameters
None
Request Data
The PUT request must include a single object with the updated boost data. See Play Service models 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:
{
"enabled": false
}
Response format and codes
| HTTP code | Description |
|---|---|
| 201 | Boost has been updated |
| 400 | Invalid parameters. Error response will include details |
| 401 | The user does not meet the security criteria |
| 404 | Boost not found |
The response will contain the updated boost data.
{
"_id": ObjectId(),
"enabled": false,
"zero_results": false,
"references": [
{"ref": "SKU12341234", "title": "..."}
],
"keywords": ["blue trousers"],
"activation_date": null,
"deactivation_date": null,
"langs": ["en_US", "en_GB"],
"extra": {},
}