{ "info": { "_postman_id": "b80e187d-254c-4ded-bc49-49f4d96dcbaf", "name": "Coveo Activity Activities Synonym API", "description": "API for Coveo Platform\n\nContact Support:\n Name: Coveo", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T01:33:13.000Z", "updatedAt": "2026-07-28T01:33:13.000Z", "lastUpdatedBy": "35240", "uid": "35240-b80e187d-254c-4ded-bc49-49f4d96dcbaf" }, "item": [ { "name": "rest", "item": [ { "name": "organizations", "item": [ { "name": "{organizationId}", "item": [ { "name": "commerce", "item": [ { "name": "v2", "item": [ { "name": "search", "item": [ { "name": "synonyms", "item": [ { "name": "{synonymId}", "item": [ { "name": "Get a Synonym Rule.", "id": "9cecbada-7560-4a70-8a21-686153fa4f46", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/commerce/v2/search/synonyms/:synonymId?trackingId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "commerce", "v2", "search", "synonyms", ":synonymId" ], "query": [ { "description": "(Required) The unique identifier of the tracking target.", "key": "trackingId", "value": "" } ], "variable": [ { "id": "23a7db7e-e5de-4770-98c1-ecfcd282927d", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `acmecorporation8tp8wu3`" }, { "id": "f48304d2-4dcf-493a-abf3-ffbb522d8d31", "key": "synonymId", "value": "", "description": "(Required) A UUID identifying the synonym rule." } ] }, "description": "Retrieves a synonym rule.

**Required privilege:** Merchandising Hub - View

Privilege required\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"MERCHANDISING_HUB\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "dc445a11-a0a7-44fb-88ee-6d53601e4741", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/commerce/v2/search/synonyms/:synonymId?trackingId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "commerce", "v2", "search", "synonyms", ":synonymId" ], "query": [ { "description": "(Required) The unique identifier of the tracking target.", "key": "trackingId", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "synonymId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"action\": \"exact-match\",\n \"from\": [\n \"\"\n ],\n \"id\": \"\",\n \"to\": [\n \"\",\n \"\"\n ],\n \"locales\": [\n {\n \"language\": \"\",\n \"country\": \"\",\n \"currency\": \"\"\n },\n {\n \"language\": \"\",\n \"country\": \"\",\n \"currency\": \"\"\n }\n ],\n \"updatedAt\": \"\"\n}", "createdAt": "2026-07-28T01:33:14.000Z", "updatedAt": "2026-07-28T01:33:14.000Z", "uid": "35240-dc445a11-a0a7-44fb-88ee-6d53601e4741" } ], "createdAt": "2026-07-28T01:33:14.000Z", "updatedAt": "2026-07-28T01:33:14.000Z", "uid": "35240-9cecbada-7560-4a70-8a21-686153fa4f46" }, { "name": "Edit Synonym Rule", "id": "c3cc2d48-28c5-484c-ac1d-15e57b6cb81d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "body": { "mode": "raw", "raw": "{\n \"action\": \"exact-match\",\n \"from\": [\n \"\"\n ],\n \"id\": \"\",\n \"to\": [\n \"\",\n \"\"\n ],\n \"locales\": [\n {\n \"language\": \"\",\n \"country\": \"\",\n \"currency\": \"\"\n },\n {\n \"language\": \"\",\n \"country\": \"\",\n \"currency\": \"\"\n }\n ],\n \"updatedAt\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/commerce/v2/search/synonyms/:synonymId?trackingId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "commerce", "v2", "search", "synonyms", ":synonymId" ], "query": [ { "description": "(Required) The unique identifier of the tracking target.", "key": "trackingId", "value": "" } ], "variable": [ { "id": "dff7fdc8-a4e0-434a-a7c0-f98bfc52f54f", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `acmecorporation8tp8wu3`" }, { "id": "6d5dd768-08d1-4d72-b41b-61d95652575c", "key": "synonymId", "value": "", "description": "(Required) A UUID identifying the synonym rule." } ] }, "description": "Updates a synonym rule.

**Required privilege:** Merchandising Hub - Edit

Privilege required\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"MERCHANDISING_HUB\",\"type\":\"EDIT\",\"targetId\":\"{trackingId}\"}\n```\n
" }, "response": [ { "id": "ea536e81-c5cc-4f18-b3c4-a14f8d6bc8a1", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"action\": \"exact-match\",\n \"from\": [\n \"\"\n ],\n \"id\": \"\",\n \"to\": [\n \"\",\n \"\"\n ],\n \"locales\": [\n {\n \"language\": \"\",\n \"country\": \"\",\n \"currency\": \"\"\n },\n {\n \"language\": \"\",\n \"country\": \"\",\n \"currency\": \"\"\n }\n ],\n \"updatedAt\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/commerce/v2/search/synonyms/:synonymId?trackingId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "commerce", "v2", "search", "synonyms", ":synonymId" ], "query": [ { "description": "(Required) The unique identifier of the tracking target.", "key": "trackingId", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "synonymId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"action\": \"exact-match\",\n \"from\": [\n \"\"\n ],\n \"id\": \"\",\n \"to\": [\n \"\",\n \"\"\n ],\n \"locales\": [\n {\n \"language\": \"\",\n \"country\": \"\",\n \"currency\": \"\"\n },\n {\n \"language\": \"\",\n \"country\": \"\",\n \"currency\": \"\"\n }\n ],\n \"updatedAt\": \"\"\n}", "createdAt": "2026-07-28T01:33:14.000Z", "updatedAt": "2026-07-28T01:33:14.000Z", "uid": "35240-ea536e81-c5cc-4f18-b3c4-a14f8d6bc8a1" } ], "createdAt": "2026-07-28T01:33:14.000Z", "updatedAt": "2026-07-28T01:33:14.000Z", "uid": "35240-c3cc2d48-28c5-484c-ac1d-15e57b6cb81d" }, { "name": "Delete Synonym Rule.", "id": "92a20733-9ed8-48ab-b971-af45e86a7a40", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/commerce/v2/search/synonyms/:synonymId?trackingId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "commerce", "v2", "search", "synonyms", ":synonymId" ], "query": [ { "description": "(Required) The unique identifier of the tracking target.", "key": "trackingId", "value": "" } ], "variable": [ { "id": "8f6742f2-1e96-4ac2-ad19-0a4f01f60721", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `acmecorporation8tp8wu3`" }, { "id": "28b64d43-aa7c-4de9-b776-492c114b1abd", "key": "synonymId", "value": "", "description": "(Required) A UUID identifying the synonym rule." } ] }, "description": "Deletes a synonym rule.

**Required privilege:** Merchandising Hub - Edit

Privilege required\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"MERCHANDISING_HUB\",\"type\":\"EDIT\",\"targetId\":\"{trackingId}\"}\n```\n
" }, "response": [ { "id": "027d6887-816f-40a8-8326-f497d1552e11", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/commerce/v2/search/synonyms/:synonymId?trackingId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "commerce", "v2", "search", "synonyms", ":synonymId" ], "query": [ { "description": "(Required) The unique identifier of the tracking target.", "key": "trackingId", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "synonymId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:33:14.000Z", "updatedAt": "2026-07-28T01:33:14.000Z", "uid": "35240-027d6887-816f-40a8-8326-f497d1552e11" } ], "createdAt": "2026-07-28T01:33:14.000Z", "updatedAt": "2026-07-28T01:33:14.000Z", "uid": "35240-92a20733-9ed8-48ab-b971-af45e86a7a40" } ], "id": "46e732c5-6ed8-4ec8-b5b7-f00a1d648fe1", "createdAt": "2026-07-28T01:33:14.000Z", "updatedAt": "2026-07-28T01:33:14.000Z", "uid": "35240-46e732c5-6ed8-4ec8-b5b7-f00a1d648fe1" }, { "name": "List Synonym Rules", "id": "1e418830-f9b7-4a52-935f-021d24105fb0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/commerce/v2/search/synonyms?trackingId=&language=bu&country=IN¤cy=MVU&query=&action=&sort=&page=0&perPage=10", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "commerce", "v2", "search", "synonyms" ], "query": [ { "description": "(Required) The unique identifier of the tracking target.", "key": "trackingId", "value": "" }, { "description": "An ISO 639-1 language code.", "key": "language", "value": "bu" }, { "description": "An ISO 3166-1 alpha-2 country code.", "key": "country", "value": "IN" }, { "description": "An ISO 4217 currency code.", "key": "currency", "value": "MVU" }, { "description": "Filter on search term (query expression) when requesting rules.", "key": "query", "value": "" }, { "description": "The synonym rule type. Possible values are: one-way, two-way, and one-way-reverse.", "key": "action", "value": "" }, { "description": "property.direction to sort by.", "key": "sort", "value": "" }, { "description": "The 0-based index number of the page of rules to retrieve.
**Minimum:** `0`
**Default:** `0`", "key": "page", "value": "0" }, { "description": "The number of rules to list per page.
**Minimum:** `1`
**Maximum:** `1000`
**Default:** `10`", "key": "perPage", "value": "10" } ], "variable": [ { "id": "685991e4-f64e-4d00-94de-611dd2e781dc", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `acmecorporation8tp8wu3`" } ] }, "description": "List synonym rules.

**Required privilege:** Merchandising Hub - View

Privilege required\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"MERCHANDISING_HUB\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "6363511d-c79d-45e6-baf6-1f734814138b", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/commerce/v2/search/synonyms?trackingId=&language=bu&country=IN¤cy=MVU&query=&action=&sort=&page=0&perPage=10", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "commerce", "v2", "search", "synonyms" ], "query": [ { "description": "(Required) The unique identifier of the tracking target.", "key": "trackingId", "value": "" }, { "description": "An ISO 639-1 language code.", "key": "language", "value": "bu" }, { "description": "An ISO 3166-1 alpha-2 country code.", "key": "country", "value": "IN" }, { "description": "An ISO 4217 currency code.", "key": "currency", "value": "MVU" }, { "description": "Filter on search term (query expression) when requesting rules.", "key": "query", "value": "" }, { "description": "The synonym rule type. Possible values are: one-way, two-way, and one-way-reverse.", "key": "action", "value": "" }, { "description": "property.direction to sort by.", "key": "sort", "value": "" }, { "description": "The 0-based index number of the page of rules to retrieve.
**Minimum:** `0`
**Default:** `0`", "key": "page", "value": "0" }, { "description": "The number of rules to list per page.
**Minimum:** `1`
**Maximum:** `1000`
**Default:** `10`", "key": "perPage", "value": "10" } ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"items\": [\n {\n \"action\": \"exact-match\",\n \"from\": [\n \"\"\n ],\n \"id\": \"\",\n \"to\": [\n \"\",\n \"\"\n ],\n \"locales\": [\n {\n \"language\": \"\",\n \"country\": \"\",\n \"currency\": \"\"\n },\n {\n \"language\": \"\",\n \"country\": \"\",\n \"currency\": \"\"\n }\n ],\n \"updatedAt\": \"\"\n },\n {\n \"action\": \"one-way\",\n \"from\": [\n \"\"\n ],\n \"id\": \"\",\n \"to\": [\n \"\",\n \"\"\n ],\n \"locales\": [\n {\n \"language\": \"\",\n \"country\": \"\",\n \"currency\": \"\"\n },\n {\n \"language\": \"\",\n \"country\": \"\",\n \"currency\": \"\"\n }\n ],\n \"updatedAt\": \"\"\n }\n ],\n \"totalEntries\": \"\",\n \"totalPages\": \"\"\n}", "createdAt": "2026-07-28T01:33:14.000Z", "updatedAt": "2026-07-28T01:33:14.000Z", "uid": "35240-6363511d-c79d-45e6-baf6-1f734814138b" } ], "createdAt": "2026-07-28T01:33:14.000Z", "updatedAt": "2026-07-28T01:33:14.000Z", "uid": "35240-1e418830-f9b7-4a52-935f-021d24105fb0" }, { "name": "Create a Synonym Rule", "id": "9bc7586b-17dd-4f6f-835c-5ea4b91ef293", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "body": { "mode": "raw", "raw": "{\n \"action\": \"exact-match\",\n \"from\": [\n \"\"\n ],\n \"id\": \"\",\n \"to\": [\n \"\",\n \"\"\n ],\n \"locales\": [\n {\n \"language\": \"\",\n \"country\": \"\",\n \"currency\": \"\"\n },\n {\n \"language\": \"\",\n \"country\": \"\",\n \"currency\": \"\"\n }\n ],\n \"updatedAt\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/commerce/v2/search/synonyms?trackingId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "commerce", "v2", "search", "synonyms" ], "query": [ { "description": "(Required) The unique identifier of the tracking target.", "key": "trackingId", "value": "" } ], "variable": [ { "id": "c4c0cad8-05d6-4446-b3e6-a35e3c60f072", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `acmecorporation8tp8wu3`" } ] }, "description": "Persists a synonym rule.

**Required privilege:** Merchandising Hub - Edit

Privilege required\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"MERCHANDISING_HUB\",\"type\":\"EDIT\",\"targetId\":\"{trackingId}\"}\n```\n
" }, "response": [ { "id": "6f5fa054-f479-44d8-b025-8e9cc68bcd47", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"action\": \"exact-match\",\n \"from\": [\n \"\"\n ],\n \"id\": \"\",\n \"to\": [\n \"\",\n \"\"\n ],\n \"locales\": [\n {\n \"language\": \"\",\n \"country\": \"\",\n \"currency\": \"\"\n },\n {\n \"language\": \"\",\n \"country\": \"\",\n \"currency\": \"\"\n }\n ],\n \"updatedAt\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/commerce/v2/search/synonyms?trackingId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "commerce", "v2", "search", "synonyms" ], "query": [ { "description": "(Required) The unique identifier of the tracking target.", "key": "trackingId", "value": "" } ], "variable": [ { "key": "organizationId" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"action\": \"exact-match\",\n \"from\": [\n \"\"\n ],\n \"id\": \"\",\n \"to\": [\n \"\",\n \"\"\n ],\n \"locales\": [\n {\n \"language\": \"\",\n \"country\": \"\",\n \"currency\": \"\"\n },\n {\n \"language\": \"\",\n \"country\": \"\",\n \"currency\": \"\"\n }\n ],\n \"updatedAt\": \"\"\n}", "createdAt": "2026-07-28T01:33:14.000Z", "updatedAt": "2026-07-28T01:33:14.000Z", "uid": "35240-6f5fa054-f479-44d8-b025-8e9cc68bcd47" } ], "createdAt": "2026-07-28T01:33:14.000Z", "updatedAt": "2026-07-28T01:33:14.000Z", "uid": "35240-9bc7586b-17dd-4f6f-835c-5ea4b91ef293" } ], "id": "a6f5de70-5bf1-4ff4-a1a2-349cdb18be04", "createdAt": "2026-07-28T01:33:14.000Z", "updatedAt": "2026-07-28T01:33:14.000Z", "uid": "35240-a6f5de70-5bf1-4ff4-a1a2-349cdb18be04" } ], "id": "8dc0cda4-f9ae-449d-8b80-6adbb6b3beea", "createdAt": "2026-07-28T01:33:14.000Z", "updatedAt": "2026-07-28T01:33:14.000Z", "uid": "35240-8dc0cda4-f9ae-449d-8b80-6adbb6b3beea" } ], "id": "bc487777-45f7-48b1-a160-f44d62cd4378", "createdAt": "2026-07-28T01:33:14.000Z", "updatedAt": "2026-07-28T01:33:14.000Z", "uid": "35240-bc487777-45f7-48b1-a160-f44d62cd4378" } ], "id": "614cd11b-a0a0-48f0-9da9-0b33dd5a3fa0", "createdAt": "2026-07-28T01:33:14.000Z", "updatedAt": "2026-07-28T01:33:14.000Z", "uid": "35240-614cd11b-a0a0-48f0-9da9-0b33dd5a3fa0" } ], "id": "a56e6da7-8b52-440e-81d6-adbf6f3d4980", "createdAt": "2026-07-28T01:33:14.000Z", "updatedAt": "2026-07-28T01:33:14.000Z", "uid": "35240-a56e6da7-8b52-440e-81d6-adbf6f3d4980" } ], "id": "abd6ee3d-e92a-4f5b-9a89-5785dfa98aab", "createdAt": "2026-07-28T01:33:14.000Z", "updatedAt": "2026-07-28T01:33:14.000Z", "uid": "35240-abd6ee3d-e92a-4f5b-9a89-5785dfa98aab" } ], "id": "0ba07c3e-7dd3-4914-87c8-e16ff3180866", "createdAt": "2026-07-28T01:33:14.000Z", "updatedAt": "2026-07-28T01:33:14.000Z", "uid": "35240-0ba07c3e-7dd3-4914-87c8-e16ff3180866" } ], "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "full", "type": "string" }, { "key": "accessTokenUrl", "value": "https://platform.cloud.coveo.com/oauth/token", "type": "string" }, { "key": "authUrl", "value": "https://platform.cloud.coveo.com/oauth/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://platform.cloud.coveo.com" } ] }