Method description
Create a new 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 POST request must include a single object with the new link data. See Play Service models for details. All non-optional fields must be included in the request.
{
"type": "catalog",
"lang": "en",
"enabled": true,
"synonyms": [
"yellow"
],
"alternatives": [
"lemon",
"banana"
],
"extra": {
"user": "username"
}
}
Response format and codes
| HTTP code | Description |
|---|---|
| 201 | Synonym has been created |
| 400 | Invalid parameters. Error response will include details |
| 401 | The user does not meet the security criteria |
When a synonym is successfully created, the response will contain the synonym itself as it has been saved on the database.
Also, a Location header will point to the URL for the synonym that was just created.
{
"type": "catalog",
"lang": "en",
"enabled": true,
"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"
}