> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cludo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Synonym Group

> Updates a synonym group.



## OpenAPI

````yaml /openapi/search-tools.json put /api/synonymsgroup
openapi: 3.1.0
info:
  title: Cludo Search Tools API
  version: 4.0.0
  description: >-
    Manage search experience tools: banners, rankings, quicklinks, and synonym
    groups for Cludo search engines.
servers:
  - url: https://api.cludo.com
    description: EU region (Customer IDs below 10,000,000)
  - url: https://api-us1.cludo.com
    description: US region (Customer IDs 10,000,000 and above)
security:
  - BasicAuth: []
paths:
  /api/synonymsgroup:
    put:
      summary: Update Synonym Group
      description: Updates a synonym group.
      operationId: updateSynonymGroup
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SynonymGroupUpdate'
      responses:
        '200':
          description: Synonym group updated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SynonymGroup'
        '202':
          description: Synonym group update accepted and processing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SynonymGroup'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: Synonym group not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - BasicAuth: []
components:
  schemas:
    SynonymGroupUpdate:
      type: object
      required:
        - groupId
        - words
        - language
      properties:
        groupId:
          type: integer
          description: Existing group to replace.
        words:
          type: array
          items:
            type: string
          description: Full new word list for the group.
        language:
          type: string
          description: Language code (must stay consistent unless migrating groups).
    SynonymGroup:
      type: object
      required:
        - groupId
        - words
        - language
      properties:
        groupId:
          type: integer
          description: Synonym group ID (assigned by server on create).
        words:
          type: array
          items:
            type: string
          description: >-
            Equivalents treated as the same intent for search (e.g.
            `motorcycle`, `bike`).
        language:
          type: string
          description: >-
            A two-letter ISO language code (e.g. `en`, `da`, `de`) this group
            applies to.
    ErrorResponse:
      type: object
      description: Error response returned when a request fails.
      properties:
        message:
          type: string
          description: A message describing what went wrong.
    UnauthorizedError:
      type: object
      description: Returned when authentication fails.
      properties:
        message:
          type: string
          description: Authentication failure reason.
    ServerError:
      type: object
      description: Returned when an unexpected server error occurs.
      properties:
        status:
          type: string
          description: HTTP status name.
        code:
          type: integer
          description: HTTP status code.
        messages:
          type: array
          items:
            type: string
          description: Error details, usually including a support reference id.
  responses:
    BadRequest:
      description: >-
        The request is invalid. This typically occurs due to missing required
        fields, incorrect parameter values, or malformed request body.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            message: >-
              The request could not be processed. Check the request body and
              required parameters.
    Unauthorized:
      description: >-
        Authentication failed. The Authorization header is missing or contains
        invalid credentials.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UnauthorizedError'
          example:
            message: unauthorized
    InternalServerError:
      description: >-
        An unexpected server error occurred. If this persists, contact
        support@cludo.com.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ServerError'
          example:
            status: InternalServerError
            code: 500
            messages:
              - >-
                Error occur. Please contact support with error ID:
                a1b2c3d4-e5f6-7890-abcd-ef1234567890
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
      description: >-
        Basic authentication. Use your Customer ID as the username and API Key
        as the password. Example header: `Authorization: Basic
        MTIzNDU2NzpteS1hcGkta2V5`.

````