Versions Compared

Key

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

Method description

Disable an existent synonym for the client {instance_id}.

URI Parameters

None

Requests

Body

None

Responses

200 - item has been disabled

Type: application/json

Code Block
languagexml
titleExample application/json
collapsetrue
{
    "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"
}
401 - the user performing the action doesn't meet the security criteria

Type: application/json

Code Block
languagexml
titleExample application/json
collapsetrue
{
  "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 Block
languagexml
titleExample application/json
collapsetrue
{
  "code": 404,
  "details": "Invalid id '123456'",
  "message": "Not Found",
  "status": "error"
}

...