You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 9
Next »
Method description
Create a new boost for the client {instance_id}.
URI Parameters
None
Requests
Body
application/json
{
"activation_date": "2016-10-25T22:00:00",
"created_on": "2017-08-08T15:27:52",
"deactivation_date": "2017-04-25T22:00:00",
"enabled": false,
"extra": {
"user": "-"
},
"keywords": [
"ring"
],
"langs": [
"en"
],
"references": [
{
"ref": "19430508",
"title": "Eternity Ring"
}
],
"zero_results": false
}
See Play Service models for details. All non-optional fields must be included in the request.
Responses
201 - item has been created
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": false,
"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": 400,
"details": "\"rows\" must be in range 10-200",
"message": "Bad Request",
"status": "error"
}
401 - the user performing the action doesn't meet the security criteria
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"
}