Method description
Update an existent boost for the client {instance_id}.
URI Parameters
None
Requests
Body
application/json
See Empathy Play API - 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.
Responses
201 - item has been updated
Type: application/json
{
"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
Type: application/json
{
"code": "validation_error",
"details": [
{
"message": "1 is not of type 'boolean'",
"path": ".enabled"
}
],
"message": "Error validating JSON",
"status": "error"
}
Type: application/json
{
"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": 404,
"details": "Invalid id '123456'",
"message": "Not Found",
"status": "error"
}