Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

Method description

Delete a boost from an instance.

Security

The calling user must have the EB_ROOT, EB_ADMIN, EB_APP, SEARCH_ADMIN or SEARCH_MANAGER role for this instance or the global instance.

specific boost for the client {instance_id}.

URI Parameters

None

Response codes

HTTP codeDescription
200Boost deleted
401The user does not meet the security criteria
404Boost not found

 

Response format

A 200 OK response will contain a single object with the deleted boost data.

...

Responses

200 - item has been deleted

Type: application/json

Code Block
titleExample application/json
collapsetrue
{
    "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": "SKU1234123419430508",
          "title": "..."Eternity Ring"
        }
    ],
    "updated_on": "2017-08-08T15:27:52",
  "keywords  "zero_results": false
}
401 - the user performing the action doesn't meet the security criteria

Type: application/json

Code Block
titleExample application/json
collapsetrue
{
  "code": 401,
  "details": ["blue trousers"]"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.",
  "activation_datemessage": null,"Unauthorized",
  "status": "error"
}
404 - the instance or item doesn't exist

Type: application/json

Code Block
titleExample application/json
collapsetrue
{
  "deactivation_datecode": null404,
  "langsdetails": ["en_US"Invalid id '123456'",
"en_GB"]  "message": "Not Found",
  "extrastatus": {}"error"
}