---
title: "Add synonym"
method: POST
path: "/api/v11/Synonym"
tags: ["Synonym"]
---

# Add synonym

`POST /api/v11/Synonym`

## Request

- Base URL: `https://indexing-dev.hawksearch.net`
- URL: `https://indexing-dev.hawksearch.net/api/v11/Synonym`
- Auth: none declared. Required headers: `X-HawkSearch-ApiKey`
- TypeScript: <https://skmtc.dev/hawksearch/apis/hawksearch-elasticsearch-indexingapi/docs/api/v11/Synonym/post.ts> (a function with typed inputs; its response is checked against the schema)

Adds a Synonym to the system

## Headers

- `X-HawkSearch-ApiKey` string, required

## Request body

- Synonym
  - `Id` integer
  - `SynonymGroup` string
  - `Comments` string
  - `Tags` string
  - `MultiWay` boolean
  - `SearchTerm` string
  - `SyncGuid` string, uuid
  - `CreateDate` string, date-time
  - `ModifyDate` string, date-time

## Response `200`

OK

- object

---

[API](https://skmtc.dev/hawksearch/apis/hawksearch-elasticsearch-indexingapi.md) - [All operations](https://skmtc.dev/hawksearch/apis/hawksearch-elasticsearch-indexingapi/llms.txt) - [OpenAPI document](https://skmtc.dev/hawksearch/apis/hawksearch-elasticsearch-indexingapi/revisions/24cba7bf3468?raw)