---
updatedAt: 2026-06-09T11:44:04.000Z
agentTools:
  projectIndex: https://docs.tweakwise.com/llms.txt
---

# Updates a synonym with the specified data, overrides all fields to the new value.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "version": "v1",
    "title": "Tweakwise Backend API"
  },
  "paths": {
    "/synonym": {
      "put": {
        "tags": [
          "Synonym"
        ],
        "summary": "Updates a synonym with the specified data, overrides all fields to the new value.",
        "operationId": "Synonym_UpdateSynonym",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SynonymUpdateModel"
              }
            },
            "text/json": {
              "schema": {
                "$ref": "#/components/schemas/SynonymUpdateModel"
              }
            }
          },
          "description": "A filled synonym to replace the current synonym",
          "required": true
        },
        "responses": {
          "200": {
            "description": "The id of the updated synonym",
            "content": {
              "application/json": {
                "schema": {
                  "format": "int64",
                  "type": "integer"
                }
              },
              "text/json": {
                "schema": {
                  "format": "int64",
                  "type": "integer"
                }
              }
            }
          },
          "400": {
            "description": "BadRequest",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationErrorContainer"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ValidationErrorContainer"
                }
              }
            }
          }
        },
        "security": [
          {
            "apiKeyDefinition": [],
            "instanceKeyDefinition": []
          }
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://navigator-api.tweakwise.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "apiKeyDefinition": {
        "type": "apiKey",
        "description": "API Key Authentication",
        "name": "TWN-Authentication",
        "in": "header"
      },
      "instanceKeyDefinition": {
        "type": "apiKey",
        "description": "Instance key",
        "name": "TWN-InstanceKey",
        "in": "header"
      }
    },
    "schemas": {
      "ValidationErrorContainer": {
        "description": "Container for all errors that occurred during the handling of a request.",
        "type": "object",
        "properties": {
          "Message": {
            "description": "Message",
            "type": "string",
            "readOnly": true
          },
          "Errors": {
            "description": "List of validation errors",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ValidationError"
            }
          }
        }
      },
      "ValidationError": {
        "description": "Error that occurred during the handling of a request.",
        "type": "object",
        "properties": {
          "Code": {
            "description": "A code for the error that, in contrast to the error message, will never change.",
            "type": "string"
          },
          "Message": {
            "description": "Explanation of why the (validation) error occurred.",
            "type": "string"
          },
          "Field": {
            "description": "To which field in the request the errors relate to. Not defined in case the errors do\r\nnot relate to a single specific field.",
            "type": "string"
          }
        }
      },
      "SynonymUpdateModel": {
        "description": "Model to update a synonym",
        "type": "object",
        "properties": {
          "Id": {
            "format": "int64",
            "description": "Id of the synonym to update",
            "type": "integer"
          },
          "SourceTerm": {
            "description": "Optional source term, if filled it is considered a one way synonym",
            "type": "string"
          },
          "Terms": {
            "description": "Synonym terms",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "Status": {
            "description": "Optional status of the synonym. The default value when none is supplied is 'Approved'",
            "enum": [
              "Pending",
              "Approved",
              "Rejected"
            ],
            "type": "string"
          }
        }
      }
    }
  }
}
```