younifyd
Menu

Update Synonym Set

Update synonym set

PUT/pcm/catalogs/search/synonym-sets/{synonym_set_id}

Use it in a workflow

  1. Add a step and choose the Elastic Path connector.
  2. Pick the Update Synonym Set action (under Catalog Search).
  3. Fill in the fields below, then reference the result from later steps as {{updateSynonymSet.response.data}}.

Request

Path parameters

synonym_set_idstring (uuid)required

The unique ID of the synonym set

Request body

Enter the body as JSON in the step's Body field.

dataobjectrequired
idstring (uuid)required
typestringrequired

Represents the type of object being returned. Always `catalog_search_synonym_set`.

One ofcatalog_search_synonym_set

attributesobjectrequired2 fields
json
{
  "data": {
    "id": "8fccaa19-dba9-4621-8d11-31a222a68c7c",
    "type": "catalog_search_synonym_set",
    "attributes": {
      "name": "Apparel terms",
      "items": [
        {
          "id": "footwear-terms",
          "synonyms": [
            "sneakers",
            "trainers",
            "running shoes"
          ],
          "root": "jacket",
          "locale": "en",
          "symbols_to_index": [
            "-"
          ]
        }
      ]
    }
  }
}

Response

Returns 200 with an object. Read it in later steps with {{updateSynonymSet.response.data.<field>}}.

dataobject
idstring (uuid)required

The unique identifier for the synonym set.

typestringrequired

Represents the type of object being returned. Always `catalog_search_synonym_set`.

One ofcatalog_search_synonym_set

attributesobjectrequired2 fields
metaobjectrequired5 fields
json
{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "type": "catalog_search_synonym_set",
    "attributes": {
      "name": "Apparel terms",
      "items": [
        {
          "id": "footwear-terms",
          "synonyms": [
            "sneakers",
            "trainers",
            "running shoes"
          ],
          "root": "jacket",
          "locale": "en",
          "symbols_to_index": [
            "-"
          ]
        }
      ]
    },
    "meta": {
      "created_at": "2026-03-05T12:00:00Z",
      "updated_at": "2026-03-05T12:00:00Z",
      "owner": "organization",
      "sync_status": "pending_sync",
      "last_synced_at": "2026-03-05T12:01:00Z"
    }
  }
}

Need more? See the Elastic Path guide for connection setup and behaviour shared by every action.