{ "info": { "_postman_id": "cbdcdf74-44b5-4cfb-a358-c2182c3ee16b", "name": "Coveo Activity Activities Context Mapping Configurations 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:27:37.000Z", "updatedAt": "2026-07-28T01:27:37.000Z", "lastUpdatedBy": "35240", "uid": "35240-cbdcdf74-44b5-4cfb-a358-c2182c3ee16b" }, "item": [ { "name": "rest", "item": [ { "name": "organizations", "item": [ { "name": "{organizationId}", "item": [ { "name": "commerce", "item": [ { "name": "v2", "item": [ { "name": "tracking-ids", "item": [ { "name": "{trackingId}", "item": [ { "name": "context-mappings", "item": [ { "name": "{key}", "item": [ { "name": "Get Context Mapping", "id": "a52a0c3d-5509-4e95-a390-f6d6bdc6cdcb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/commerce/v2/tracking-ids/:trackingId/context-mappings/:key", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "commerce", "v2", "tracking-ids", ":trackingId", "context-mappings", ":key" ], "variable": [ { "id": "29e5935b-a214-413e-837d-1ac909f6a642", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `acmecorporation8tp8wu3`" }, { "id": "7638fc2f-eceb-4b29-92c2-610055871169", "key": "trackingId", "value": "", "description": "(Required) The unique identifier of the tracking target." }, { "id": "ca998fd3-5441-465d-8db0-001c78797990", "key": "key", "value": "", "description": "(Required) The context mapping key" } ] }, "description": "Gets a specific context mapping by key.

**Required privilege:** Merchandising Hub - View

Privilege required\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"MERCHANDISING_HUB\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "0e417e35-d3e1-48fb-8f63-7df886fe833b", "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/tracking-ids/:trackingId/context-mappings/:key", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "commerce", "v2", "tracking-ids", ":trackingId", "context-mappings", ":key" ], "variable": [ { "key": "organizationId" }, { "key": "trackingId" }, { "key": "key" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"destinations\": [\n {\n \"attribute\": \"ML_CONTEXT\",\n \"fieldAlias\": \"\",\n \"fieldSource\": \"\"\n }\n ],\n \"key\": \"GEr14WRLPBCQ2BGz3QmqxK1nyD_VXVgB48VJT6C8YX4JxxL99JLa1b0HJe\",\n \"type\": \"NUMBER\"\n}", "createdAt": "2026-07-28T01:27:37.000Z", "updatedAt": "2026-07-28T01:27:37.000Z", "uid": "35240-0e417e35-d3e1-48fb-8f63-7df886fe833b" } ], "createdAt": "2026-07-28T01:27:37.000Z", "updatedAt": "2026-07-28T01:27:37.000Z", "uid": "35240-a52a0c3d-5509-4e95-a390-f6d6bdc6cdcb" }, { "name": "Update Context Mapping", "id": "1fd24006-7013-4a69-b0a0-7f43dae6112c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "body": { "mode": "raw", "raw": "{\n \"destinations\": [\n {\n \"attribute\": \"ML_CONTEXT\",\n \"fieldAlias\": \"\",\n \"fieldSource\": \"\"\n }\n ],\n \"key\": \"GEr14WRLPBCQ2BGz3QmqxK1nyD_VXVgB48VJT6C8YX4JxxL99JLa1b0HJe\",\n \"type\": \"NUMBER\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/commerce/v2/tracking-ids/:trackingId/context-mappings/:key", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "commerce", "v2", "tracking-ids", ":trackingId", "context-mappings", ":key" ], "variable": [ { "id": "5c3682da-fe03-4afc-9c66-b158f57117a0", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `acmecorporation8tp8wu3`" }, { "id": "b7252ea9-20e6-4777-8476-79e890cfac55", "key": "trackingId", "value": "", "description": "(Required) The unique identifier of the tracking target." }, { "id": "14372c67-398f-4875-adec-e4bdf34dabe1", "key": "key", "value": "", "description": "(Required) The context mapping key" } ] }, "description": "Updates an existing context mapping by key

**Required privilege:** Merchandising Hub - Edit

Privilege required\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"MERCHANDISING_HUB\",\"type\":\"EDIT\",\"targetId\":\"{trackingId}\"}\n```\n
" }, "response": [ { "id": "4addb89d-b659-4000-a0c5-df67548b6b4b", "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 \"destinations\": [\n {\n \"attribute\": \"ML_CONTEXT\",\n \"fieldAlias\": \"\",\n \"fieldSource\": \"\"\n }\n ],\n \"key\": \"GEr14WRLPBCQ2BGz3QmqxK1nyD_VXVgB48VJT6C8YX4JxxL99JLa1b0HJe\",\n \"type\": \"NUMBER\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/commerce/v2/tracking-ids/:trackingId/context-mappings/:key", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "commerce", "v2", "tracking-ids", ":trackingId", "context-mappings", ":key" ], "variable": [ { "key": "organizationId" }, { "key": "trackingId" }, { "key": "key" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"destinations\": [\n {\n \"attribute\": \"ML_CONTEXT\",\n \"fieldAlias\": \"\",\n \"fieldSource\": \"\"\n }\n ],\n \"key\": \"GEr14WRLPBCQ2BGz3QmqxK1nyD_VXVgB48VJT6C8YX4JxxL99JLa1b0HJe\",\n \"type\": \"NUMBER\"\n}", "createdAt": "2026-07-28T01:27:37.000Z", "updatedAt": "2026-07-28T01:27:37.000Z", "uid": "35240-4addb89d-b659-4000-a0c5-df67548b6b4b" } ], "createdAt": "2026-07-28T01:27:37.000Z", "updatedAt": "2026-07-28T01:27:37.000Z", "uid": "35240-1fd24006-7013-4a69-b0a0-7f43dae6112c" }, { "name": "Delete Context Mapping", "id": "accb942a-70a8-4416-9b4b-3543c43575a7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/commerce/v2/tracking-ids/:trackingId/context-mappings/:key", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "commerce", "v2", "tracking-ids", ":trackingId", "context-mappings", ":key" ], "variable": [ { "id": "d5159972-9312-4302-8666-dd2ec41f32d4", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `acmecorporation8tp8wu3`" }, { "id": "fd86b994-8dd0-4864-83b5-915a3945e647", "key": "trackingId", "value": "", "description": "(Required) The unique identifier of the tracking target." }, { "id": "fdb5397f-44c3-4f30-992c-3f6544d3f5af", "key": "key", "value": "", "description": "(Required) The context mapping key" } ] }, "description": "Deletes a specific context mapping by key.

**Required privilege:** Merchandising Hub - Edit

Privilege required\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"MERCHANDISING_HUB\",\"type\":\"EDIT\",\"targetId\":\"{trackingId}\"}\n```\n
" }, "response": [ { "id": "9c40f0cd-b367-4af7-ac1b-bb22dcd2686b", "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/tracking-ids/:trackingId/context-mappings/:key", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "commerce", "v2", "tracking-ids", ":trackingId", "context-mappings", ":key" ], "variable": [ { "key": "organizationId" }, { "key": "trackingId" }, { "key": "key" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:27:37.000Z", "updatedAt": "2026-07-28T01:27:37.000Z", "uid": "35240-9c40f0cd-b367-4af7-ac1b-bb22dcd2686b" } ], "createdAt": "2026-07-28T01:27:37.000Z", "updatedAt": "2026-07-28T01:27:37.000Z", "uid": "35240-accb942a-70a8-4416-9b4b-3543c43575a7" } ], "id": "d9f5718b-936f-413c-836a-35f14a294c10", "createdAt": "2026-07-28T01:27:37.000Z", "updatedAt": "2026-07-28T01:27:37.000Z", "uid": "35240-d9f5718b-936f-413c-836a-35f14a294c10" }, { "name": "List Context Mappings", "id": "324a9ceb-85ed-4436-bcc4-002b2306c09f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/commerce/v2/tracking-ids/:trackingId/context-mappings", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "commerce", "v2", "tracking-ids", ":trackingId", "context-mappings" ], "variable": [ { "id": "ea7995b1-73bf-4450-b757-7ec227f28537", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `acmecorporation8tp8wu3`" }, { "id": "4715e62f-5485-4222-ac32-7240ac177fdd", "key": "trackingId", "value": "", "description": "(Required) The unique identifier of the tracking target." } ] }, "description": "Lists all context mapping configurations.

**Required privilege:** Merchandising Hub - View

Privilege required\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"MERCHANDISING_HUB\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "a761bc64-6eb9-4b4a-a033-4d0987c8b113", "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/tracking-ids/:trackingId/context-mappings", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "commerce", "v2", "tracking-ids", ":trackingId", "context-mappings" ], "variable": [ { "key": "organizationId" }, { "key": "trackingId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"destinations\": [\n {\n \"attribute\": \"QUERY_PIPELINE_CONTEXT\",\n \"fieldAlias\": \"\",\n \"fieldSource\": \"\"\n }\n ],\n \"key\": \"AgaL7L_SbGp8fowOdJF6pX7XGYW\",\n \"type\": \"PRODUCT_LIST\"\n },\n {\n \"destinations\": [\n {\n \"attribute\": \"ML_CONTEXT\",\n \"fieldAlias\": \"\",\n \"fieldSource\": \"\"\n }\n ],\n \"key\": \"dIX2KyVKdap7edkYf8epizL_ppGBKIBBz4Td2EIa4mkvaMzEcsp3z\",\n \"type\": \"NUMBER\"\n }\n]", "createdAt": "2026-07-28T01:27:37.000Z", "updatedAt": "2026-07-28T01:27:37.000Z", "uid": "35240-a761bc64-6eb9-4b4a-a033-4d0987c8b113" } ], "createdAt": "2026-07-28T01:27:37.000Z", "updatedAt": "2026-07-28T01:27:37.000Z", "uid": "35240-324a9ceb-85ed-4436-bcc4-002b2306c09f" }, { "name": "Creates a Context Mapping", "id": "38c136da-475b-42da-b4ef-c1fb426a2636", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "body": { "mode": "raw", "raw": "{\n \"destinations\": [\n {\n \"attribute\": \"ML_CONTEXT\",\n \"fieldAlias\": \"\",\n \"fieldSource\": \"\"\n }\n ],\n \"key\": \"GEr14WRLPBCQ2BGz3QmqxK1nyD_VXVgB48VJT6C8YX4JxxL99JLa1b0HJe\",\n \"type\": \"NUMBER\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/commerce/v2/tracking-ids/:trackingId/context-mappings", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "commerce", "v2", "tracking-ids", ":trackingId", "context-mappings" ], "variable": [ { "id": "11ab4fb9-d3b1-4a2f-b389-0cab676d8434", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `acmecorporation8tp8wu3`" }, { "id": "e48e526f-701d-4f3c-8814-9d1a1ad4f274", "key": "trackingId", "value": "", "description": "(Required) The unique identifier of the tracking target." } ] }, "description": "Creates a context mapping for a specific key.

**Required privilege:** Merchandising Hub - Edit

Privilege required\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"MERCHANDISING_HUB\",\"type\":\"EDIT\",\"targetId\":\"{trackingId}\"}\n```\n
" }, "response": [ { "id": "652716f0-4319-42e5-a76c-d4a0075497e3", "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 \"destinations\": [\n {\n \"attribute\": \"ML_CONTEXT\",\n \"fieldAlias\": \"\",\n \"fieldSource\": \"\"\n }\n ],\n \"key\": \"GEr14WRLPBCQ2BGz3QmqxK1nyD_VXVgB48VJT6C8YX4JxxL99JLa1b0HJe\",\n \"type\": \"NUMBER\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/commerce/v2/tracking-ids/:trackingId/context-mappings", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "commerce", "v2", "tracking-ids", ":trackingId", "context-mappings" ], "variable": [ { "key": "organizationId" }, { "key": "trackingId" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"destinations\": [\n {\n \"attribute\": \"ML_CONTEXT\",\n \"fieldAlias\": \"\",\n \"fieldSource\": \"\"\n }\n ],\n \"key\": \"GEr14WRLPBCQ2BGz3QmqxK1nyD_VXVgB48VJT6C8YX4JxxL99JLa1b0HJe\",\n \"type\": \"NUMBER\"\n}", "createdAt": "2026-07-28T01:27:37.000Z", "updatedAt": "2026-07-28T01:27:37.000Z", "uid": "35240-652716f0-4319-42e5-a76c-d4a0075497e3" } ], "createdAt": "2026-07-28T01:27:37.000Z", "updatedAt": "2026-07-28T01:27:37.000Z", "uid": "35240-38c136da-475b-42da-b4ef-c1fb426a2636" } ], "id": "63c10612-f9bd-473f-9165-612ca1ae0e85", "createdAt": "2026-07-28T01:27:37.000Z", "updatedAt": "2026-07-28T01:27:37.000Z", "uid": "35240-63c10612-f9bd-473f-9165-612ca1ae0e85" } ], "id": "c6f0ad46-0fd0-48dc-99b3-46a8a6f27222", "createdAt": "2026-07-28T01:27:37.000Z", "updatedAt": "2026-07-28T01:27:37.000Z", "uid": "35240-c6f0ad46-0fd0-48dc-99b3-46a8a6f27222" } ], "id": "b2cac8a9-aa09-4cd4-961a-a91a3fd1b49f", "createdAt": "2026-07-28T01:27:37.000Z", "updatedAt": "2026-07-28T01:27:37.000Z", "uid": "35240-b2cac8a9-aa09-4cd4-961a-a91a3fd1b49f" } ], "id": "00af1e2a-4aff-4687-8504-77e8f39cb8df", "createdAt": "2026-07-28T01:27:37.000Z", "updatedAt": "2026-07-28T01:27:37.000Z", "uid": "35240-00af1e2a-4aff-4687-8504-77e8f39cb8df" } ], "id": "013fb9ba-7dbf-40cb-a8e3-6f6d39556b89", "createdAt": "2026-07-28T01:27:37.000Z", "updatedAt": "2026-07-28T01:27:37.000Z", "uid": "35240-013fb9ba-7dbf-40cb-a8e3-6f6d39556b89" } ], "id": "d0e5d775-92c1-4829-b403-59be038b6225", "createdAt": "2026-07-28T01:27:37.000Z", "updatedAt": "2026-07-28T01:27:37.000Z", "uid": "35240-d0e5d775-92c1-4829-b403-59be038b6225" } ], "id": "5acf6bf8-775a-47df-a4e9-d21b73aa8946", "createdAt": "2026-07-28T01:27:37.000Z", "updatedAt": "2026-07-28T01:27:37.000Z", "uid": "35240-5acf6bf8-775a-47df-a4e9-d21b73aa8946" } ], "id": "7b8cbd22-565c-40cf-8123-be9462e6aa10", "createdAt": "2026-07-28T01:27:37.000Z", "updatedAt": "2026-07-28T01:27:37.000Z", "uid": "35240-7b8cbd22-565c-40cf-8123-be9462e6aa10" } ], "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" } ] }