Page Comparison

...

...

...

...

Method description

Update an existing existent synonym 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 synonym data. the client {instance_id}.

URI Parameters

None

Requests

Body

application/json

{
  "enabled": false,
}

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 or change the synonym type.

Example to disable a link:

{
  "enabled": false
}

Response format and codes

...

Responses

201 - item has been updated

...

The response will contain the updated link data.

...

Type: application/json

{
    "type": "catalog",
    "lang": "en",
    "enabled": false,
    "synonyms": [
        "yellow"
    ],
    "alternatives": [
        "lemon",
        "banana"
    ],
    "extra": {
        "user": "username"
    },
    "batched": false,
    "id": "586c267572c547cdcb51be9c",
    "created_on": "2017-01-03T22:32:21"
    "updated_on": "2017-01-03T22:32:21"
}

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