Page Comparison

...

...

...

...

Method description

Update an existing existent blacklist item for this 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.

Request Parameters

None

Request Data

The PUT request must include a single object with the updated blacklist data. the client {instance_id}.

URI Parameters

None

Requests

Body

application/json

{
    "terms": "test1 modified"
}

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.

Responses

201 - item has been updated

...

The response will contain the updated blacklist data.

...

Type: application/json

{
  "created_on": "2017-02-15T14:58:34",
  "id": "58a46c9af9cdda5624204134",
  "lang": "es_ES",
  "terms": "prueba 1 es_ES modified",
  "updated_on": "2017-02-16T14:02:26"
}

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"
}

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"
}

404 - the instance or item doesn't exist

Type: application/json

{
  "code": 404,
  "details": "Invalid id '123456'",
  "message": "Not Found",
  "status": "error"
}