{ "info": { "_postman_id": "25e2b1ae-7439-4e22-8179-3dd789899291", "name": "Coveo Activity Activities Statement groups 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:32:47.000Z", "updatedAt": "2026-07-28T01:32:47.000Z", "lastUpdatedBy": "35240", "uid": "35240-25e2b1ae-7439-4e22-8179-3dd789899291" }, "item": [ { "name": "rest", "item": [ { "name": "search", "item": [ { "name": "v2", "item": [ { "name": "admin", "item": [ { "name": "pipelines", "item": [ { "name": "{pipelineId}", "item": [ { "name": "statementGroups", "item": [ { "name": "associations", "item": [ { "name": "dissociate", "item": [ { "name": "Dissociate Pipeline Rules Associated to Groups", "id": "42e36223-4e47-4d30-bb80-70d7cc8ec8ca", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"associations\": [\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n },\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/associations/dissociate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", "associations", "dissociate" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "id": "825ce982-ea04-449c-96b0-b876b0607be0", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." } ] }, "description": "
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"EDIT\",\"targetId\":\"{pipelineId}\"}\n```\n
" }, "response": [ { "id": "2a5996f5-dbdd-492f-a722-7230848a4471", "name": "Successfully dissociated the items.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"associations\": [\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n },\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/associations/dissociate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", "associations", "dissociate" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-2a5996f5-dbdd-492f-a722-7230848a4471" }, { "id": "c2a8d29c-6f76-4d5d-afd8-ab441a22d0bb", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"associations\": [\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n },\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/associations/dissociate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", "associations", "dissociate" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-c2a8d29c-6f76-4d5d-afd8-ab441a22d0bb" }, { "id": "9cae5f46-3c8d-4d36-98aa-4c03936cedae", "name": "Unauthorized (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#401-unauthorized)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"associations\": [\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n },\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/associations/dissociate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", "associations", "dissociate" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-9cae5f46-3c8d-4d36-98aa-4c03936cedae" }, { "id": "483208d4-a234-45d6-afe7-0344d27c0b82", "name": "Forbidden (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#403-forbidden)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"associations\": [\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n },\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/associations/dissociate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", "associations", "dissociate" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-483208d4-a234-45d6-afe7-0344d27c0b82" }, { "id": "7727a1a4-acb8-47e2-9064-5afd38a6f80d", "name": "Authentication Timeout", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"associations\": [\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n },\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/associations/dissociate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", "associations", "dissociate" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-7727a1a4-acb8-47e2-9064-5afd38a6f80d" }, { "id": "664318ac-e828-4c3a-a80a-62b7f6eb1e1d", "name": "The request to update the rules associated with the statement group could not be processed", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"associations\": [\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n },\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/associations/dissociate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", "associations", "dissociate" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-664318ac-e828-4c3a-a80a-62b7f6eb1e1d" }, { "id": "8d683680-0e80-4e13-bff8-df647c07a290", "name": "Too Many Requests (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#429-too_many_requests)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"associations\": [\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n },\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/associations/dissociate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", "associations", "dissociate" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-8d683680-0e80-4e13-bff8-df647c07a290" }, { "id": "4d8da0b8-5d55-4042-aea5-ae454aa650dd", "name": "Service Unavailable (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#5xx)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"associations\": [\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n },\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/associations/dissociate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", "associations", "dissociate" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-4d8da0b8-5d55-4042-aea5-ae454aa650dd" } ], "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-42e36223-4e47-4d30-bb80-70d7cc8ec8ca" } ], "id": "f9bf22bc-95b7-4a2d-a187-9e3fcb8b58d4", "createdAt": "2026-07-28T01:32:47.000Z", "updatedAt": "2026-07-28T01:32:47.000Z", "uid": "35240-f9bf22bc-95b7-4a2d-a187-9e3fcb8b58d4" } ], "id": "75202c32-bb28-4e2c-a74b-29dc256bdc26", "createdAt": "2026-07-28T01:32:47.000Z", "updatedAt": "2026-07-28T01:32:47.000Z", "uid": "35240-75202c32-bb28-4e2c-a74b-29dc256bdc26" }, { "name": "bulkGet", "item": [ { "name": "List Statement Groups of a Pipeline", "id": "ac20aa92-6b7e-47ce-8282-64a74285a50b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/bulkGet?organizationId=&page=0&perPage=20", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", "bulkGet" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" } ], "variable": [ { "id": "53fcc479-7922-49bf-b331-5837ac81153a", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." } ] }, "description": "List statement groups of a pipeline\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"VIEW\",\"targetId\":\"{pipelineId}\"}\n```\n
" }, "response": [ { "id": "38a98b6d-7694-4033-93be-73a56ea472fe", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/bulkGet?organizationId=&page=0&perPage=20", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", "bulkGet" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"groupComposition\": {\n \"campaignGroupCount\": \"\",\n \"permanentGroupCount\": \"\",\n \"activeGroupCount\": \"\",\n \"inactiveGroupCount\": \"\",\n \"expiredGroupCount\": \"\",\n \"notStartedGroupCount\": \"\"\n },\n \"groups\": [\n {\n \"id\": \"\",\n \"type\": \"permanent\",\n \"name\": \"\",\n \"statementComposition\": {\n \"otherStatementCount\": \"\",\n \"resultRankingStatementCount\": \"\"\n },\n \"createdAt\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"conditionId\": \"\",\n \"conditionDefinition\": \"\",\n \"conditionDetailed\": {\n \"description\": \"A structured representation of the condition.\"\n },\n \"createdBy\": \"\",\n \"modifiedAt\": \"\",\n \"modifiedBy\": \"\",\n \"campaignStart\": \"\",\n \"campaignEnd\": \"\",\n \"status\": \"notStarted\"\n },\n {\n \"id\": \"\",\n \"type\": \"permanent\",\n \"name\": \"\",\n \"statementComposition\": {\n \"otherStatementCount\": \"\",\n \"resultRankingStatementCount\": \"\"\n },\n \"createdAt\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"conditionId\": \"\",\n \"conditionDefinition\": \"\",\n \"conditionDetailed\": {\n \"description\": \"A structured representation of the condition.\"\n },\n \"createdBy\": \"\",\n \"modifiedAt\": \"\",\n \"modifiedBy\": \"\",\n \"campaignStart\": \"\",\n \"campaignEnd\": \"\",\n \"status\": \"active\"\n }\n ],\n \"totalCount\": \"\"\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-38a98b6d-7694-4033-93be-73a56ea472fe" }, { "id": "bab260c0-02c5-4a0f-bdd9-67f7a92c0498", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/bulkGet?organizationId=&page=0&perPage=20", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", "bulkGet" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-bab260c0-02c5-4a0f-bdd9-67f7a92c0498" }, { "id": "f5f046a0-3c5a-47dd-8347-89c28f10aa95", "name": "Unauthorized (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#401-unauthorized)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/bulkGet?organizationId=&page=0&perPage=20", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", "bulkGet" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-f5f046a0-3c5a-47dd-8347-89c28f10aa95" }, { "id": "269e24c0-918e-445a-95c8-a34e4c9c194b", "name": "Forbidden (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#403-forbidden)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/bulkGet?organizationId=&page=0&perPage=20", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", "bulkGet" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-269e24c0-918e-445a-95c8-a34e4c9c194b" }, { "id": "806bfeba-cc52-462c-a7a5-ea240e542eba", "name": "Authentication Timeout", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/bulkGet?organizationId=&page=0&perPage=20", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", "bulkGet" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" } ], "variable": [ { "key": "pipelineId" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-806bfeba-cc52-462c-a7a5-ea240e542eba" }, { "id": "a69e19bd-cf88-4979-a6f4-764deaa4f4b9", "name": "Too Many Requests (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#429-too_many_requests)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/bulkGet?organizationId=&page=0&perPage=20", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", "bulkGet" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-a69e19bd-cf88-4979-a6f4-764deaa4f4b9" } ], "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-ac20aa92-6b7e-47ce-8282-64a74285a50b" } ], "id": "3be09deb-1ffb-4b7e-a058-7dbae1f936ea", "createdAt": "2026-07-28T01:32:47.000Z", "updatedAt": "2026-07-28T01:32:47.000Z", "uid": "35240-3be09deb-1ffb-4b7e-a058-7dbae1f936ea" }, { "name": "validate", "item": [ { "name": "batch", "item": [ { "name": "Validate a Batch of Statement Groups Operations.", "id": "19483211-9987-4f19-ae3b-c16f6b012cbe", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"operations\": [\n {\n \"operationType\": \"DELETE\",\n \"model\": {\n \"campaignEnd\": \"\",\n \"campaignStart\": \"\",\n \"name\": \"\",\n \"type\": \"campaign\",\n \"description\": \"\",\n \"conditionId\": \"\"\n },\n \"resourceId\": \"\"\n },\n {\n \"operationType\": \"DELETE\",\n \"model\": {\n \"campaignEnd\": \"\",\n \"campaignStart\": \"\",\n \"name\": \"\",\n \"type\": \"permanent\",\n \"description\": \"\",\n \"conditionId\": \"\"\n },\n \"resourceId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/validate/batch?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", "validate", "batch" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "id": "2fd9e631-7067-4e67-8412-2690bf0c00c3", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." } ] }, "description": "\nValidate that a list of operations would be accepted by our API and executed.\nA maximum of 15 can be processed per request.\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"VIEW\",\"targetId\":\"{pipelineId}\"}\n```\n
" }, "response": [ { "id": "a1ceb35e-8c07-4472-9677-421ae19185d1", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"operations\": [\n {\n \"operationType\": \"DELETE\",\n \"model\": {\n \"campaignEnd\": \"\",\n \"campaignStart\": \"\",\n \"name\": \"\",\n \"type\": \"campaign\",\n \"description\": \"\",\n \"conditionId\": \"\"\n },\n \"resourceId\": \"\"\n },\n {\n \"operationType\": \"DELETE\",\n \"model\": {\n \"campaignEnd\": \"\",\n \"campaignStart\": \"\",\n \"name\": \"\",\n \"type\": \"permanent\",\n \"description\": \"\",\n \"conditionId\": \"\"\n },\n \"resourceId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/validate/batch?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", "validate", "batch" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"results\": [\n {\n \"operationType\": \"\",\n \"operationValid\": \"\",\n \"resourceId\": \"\",\n \"validationErrors\": {\n \"occaecat_a\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ]\n }\n },\n {\n \"operationType\": \"\",\n \"operationValid\": \"\",\n \"resourceId\": \"\",\n \"validationErrors\": {\n \"Excepteur_b_0\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ]\n }\n }\n ]\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-a1ceb35e-8c07-4472-9677-421ae19185d1" }, { "id": "5211d78f-77cf-4600-95f3-9b9188948f18", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"operations\": [\n {\n \"operationType\": \"DELETE\",\n \"model\": {\n \"campaignEnd\": \"\",\n \"campaignStart\": \"\",\n \"name\": \"\",\n \"type\": \"campaign\",\n \"description\": \"\",\n \"conditionId\": \"\"\n },\n \"resourceId\": \"\"\n },\n {\n \"operationType\": \"DELETE\",\n \"model\": {\n \"campaignEnd\": \"\",\n \"campaignStart\": \"\",\n \"name\": \"\",\n \"type\": \"permanent\",\n \"description\": \"\",\n \"conditionId\": \"\"\n },\n \"resourceId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/validate/batch?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", "validate", "batch" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-5211d78f-77cf-4600-95f3-9b9188948f18" }, { "id": "ff6ce94c-744f-42c3-a090-9bcbdb56fe8e", "name": "Unauthorized (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#401-unauthorized)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"operations\": [\n {\n \"operationType\": \"DELETE\",\n \"model\": {\n \"campaignEnd\": \"\",\n \"campaignStart\": \"\",\n \"name\": \"\",\n \"type\": \"campaign\",\n \"description\": \"\",\n \"conditionId\": \"\"\n },\n \"resourceId\": \"\"\n },\n {\n \"operationType\": \"DELETE\",\n \"model\": {\n \"campaignEnd\": \"\",\n \"campaignStart\": \"\",\n \"name\": \"\",\n \"type\": \"permanent\",\n \"description\": \"\",\n \"conditionId\": \"\"\n },\n \"resourceId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/validate/batch?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", "validate", "batch" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-ff6ce94c-744f-42c3-a090-9bcbdb56fe8e" }, { "id": "14a7808c-ccc7-419c-ba5e-4f5c0a248f17", "name": "Forbidden (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#403-forbidden)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"operations\": [\n {\n \"operationType\": \"DELETE\",\n \"model\": {\n \"campaignEnd\": \"\",\n \"campaignStart\": \"\",\n \"name\": \"\",\n \"type\": \"campaign\",\n \"description\": \"\",\n \"conditionId\": \"\"\n },\n \"resourceId\": \"\"\n },\n {\n \"operationType\": \"DELETE\",\n \"model\": {\n \"campaignEnd\": \"\",\n \"campaignStart\": \"\",\n \"name\": \"\",\n \"type\": \"permanent\",\n \"description\": \"\",\n \"conditionId\": \"\"\n },\n \"resourceId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/validate/batch?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", "validate", "batch" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-14a7808c-ccc7-419c-ba5e-4f5c0a248f17" }, { "id": "06421d61-d5d1-4138-9882-228296aeeba6", "name": "Authentication Timeout", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"operations\": [\n {\n \"operationType\": \"DELETE\",\n \"model\": {\n \"campaignEnd\": \"\",\n \"campaignStart\": \"\",\n \"name\": \"\",\n \"type\": \"campaign\",\n \"description\": \"\",\n \"conditionId\": \"\"\n },\n \"resourceId\": \"\"\n },\n {\n \"operationType\": \"DELETE\",\n \"model\": {\n \"campaignEnd\": \"\",\n \"campaignStart\": \"\",\n \"name\": \"\",\n \"type\": \"permanent\",\n \"description\": \"\",\n \"conditionId\": \"\"\n },\n \"resourceId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/validate/batch?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", "validate", "batch" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-06421d61-d5d1-4138-9882-228296aeeba6" }, { "id": "ef384fb9-b5a7-41e6-ba6b-1142aef74b86", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"operations\": [\n {\n \"operationType\": \"DELETE\",\n \"model\": {\n \"campaignEnd\": \"\",\n \"campaignStart\": \"\",\n \"name\": \"\",\n \"type\": \"campaign\",\n \"description\": \"\",\n \"conditionId\": \"\"\n },\n \"resourceId\": \"\"\n },\n {\n \"operationType\": \"DELETE\",\n \"model\": {\n \"campaignEnd\": \"\",\n \"campaignStart\": \"\",\n \"name\": \"\",\n \"type\": \"permanent\",\n \"description\": \"\",\n \"conditionId\": \"\"\n },\n \"resourceId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/validate/batch?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", "validate", "batch" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-ef384fb9-b5a7-41e6-ba6b-1142aef74b86" }, { "id": "689c8fea-eb80-4fbd-bb2e-0d7308e25d86", "name": "Too Many Requests (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#429-too_many_requests)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"operations\": [\n {\n \"operationType\": \"DELETE\",\n \"model\": {\n \"campaignEnd\": \"\",\n \"campaignStart\": \"\",\n \"name\": \"\",\n \"type\": \"campaign\",\n \"description\": \"\",\n \"conditionId\": \"\"\n },\n \"resourceId\": \"\"\n },\n {\n \"operationType\": \"DELETE\",\n \"model\": {\n \"campaignEnd\": \"\",\n \"campaignStart\": \"\",\n \"name\": \"\",\n \"type\": \"permanent\",\n \"description\": \"\",\n \"conditionId\": \"\"\n },\n \"resourceId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/validate/batch?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", "validate", "batch" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-689c8fea-eb80-4fbd-bb2e-0d7308e25d86" }, { "id": "fabfef2d-281f-425f-85c7-ec438a849003", "name": "Service Unavailable (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#5xx)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"operations\": [\n {\n \"operationType\": \"DELETE\",\n \"model\": {\n \"campaignEnd\": \"\",\n \"campaignStart\": \"\",\n \"name\": \"\",\n \"type\": \"campaign\",\n \"description\": \"\",\n \"conditionId\": \"\"\n },\n \"resourceId\": \"\"\n },\n {\n \"operationType\": \"DELETE\",\n \"model\": {\n \"campaignEnd\": \"\",\n \"campaignStart\": \"\",\n \"name\": \"\",\n \"type\": \"permanent\",\n \"description\": \"\",\n \"conditionId\": \"\"\n },\n \"resourceId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/validate/batch?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", "validate", "batch" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-fabfef2d-281f-425f-85c7-ec438a849003" } ], "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-19483211-9987-4f19-ae3b-c16f6b012cbe" } ], "id": "b9103d81-a71c-4f74-bab6-c86c80437eea", "createdAt": "2026-07-28T01:32:47.000Z", "updatedAt": "2026-07-28T01:32:47.000Z", "uid": "35240-b9103d81-a71c-4f74-bab6-c86c80437eea" }, { "name": "Validate a Single Statement Group Operation.", "id": "1d8dbf04-3c37-4294-bd6b-736d36ac58a9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"operation\": {\n \"operationType\": \"UPDATE\",\n \"model\": {\n \"campaignEnd\": \"\",\n \"campaignStart\": \"\",\n \"name\": \"\",\n \"type\": \"permanent\",\n \"description\": \"\",\n \"conditionId\": \"\"\n },\n \"resourceId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/validate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", "validate" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "id": "5159a32a-81cc-45dc-a669-c9e719266c42", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." } ] }, "description": "Validate that a specific operation would be accepted by our API and executed.\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"VIEW\",\"targetId\":\"{pipelineId}\"}\n```\n
" }, "response": [ { "id": "8418343a-d99b-434b-9097-f338df0c1e5e", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"operation\": {\n \"operationType\": \"UPDATE\",\n \"model\": {\n \"campaignEnd\": \"\",\n \"campaignStart\": \"\",\n \"name\": \"\",\n \"type\": \"permanent\",\n \"description\": \"\",\n \"conditionId\": \"\"\n },\n \"resourceId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/validate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", "validate" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"result\": {\n \"operationType\": \"\",\n \"operationValid\": \"\",\n \"resourceId\": \"\",\n \"validationErrors\": {\n \"labore_c\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ],\n \"velit82\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ],\n \"nulla05c\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ]\n }\n }\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-8418343a-d99b-434b-9097-f338df0c1e5e" }, { "id": "e38ee9d4-5436-4fef-a7e4-42f2afa55d86", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"operation\": {\n \"operationType\": \"UPDATE\",\n \"model\": {\n \"campaignEnd\": \"\",\n \"campaignStart\": \"\",\n \"name\": \"\",\n \"type\": \"permanent\",\n \"description\": \"\",\n \"conditionId\": \"\"\n },\n \"resourceId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/validate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", "validate" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-e38ee9d4-5436-4fef-a7e4-42f2afa55d86" }, { "id": "2c125cd0-992f-40f9-95d1-db63552ab050", "name": "Unauthorized (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#401-unauthorized)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"operation\": {\n \"operationType\": \"UPDATE\",\n \"model\": {\n \"campaignEnd\": \"\",\n \"campaignStart\": \"\",\n \"name\": \"\",\n \"type\": \"permanent\",\n \"description\": \"\",\n \"conditionId\": \"\"\n },\n \"resourceId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/validate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", "validate" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-2c125cd0-992f-40f9-95d1-db63552ab050" }, { "id": "1c26ff95-492d-4b79-9735-b36caed1d8e5", "name": "Forbidden (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#403-forbidden)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"operation\": {\n \"operationType\": \"UPDATE\",\n \"model\": {\n \"campaignEnd\": \"\",\n \"campaignStart\": \"\",\n \"name\": \"\",\n \"type\": \"permanent\",\n \"description\": \"\",\n \"conditionId\": \"\"\n },\n \"resourceId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/validate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", "validate" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-1c26ff95-492d-4b79-9735-b36caed1d8e5" }, { "id": "fac81c5d-fb56-401a-a9e9-e63f5caa13af", "name": "Authentication Timeout", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"operation\": {\n \"operationType\": \"UPDATE\",\n \"model\": {\n \"campaignEnd\": \"\",\n \"campaignStart\": \"\",\n \"name\": \"\",\n \"type\": \"permanent\",\n \"description\": \"\",\n \"conditionId\": \"\"\n },\n \"resourceId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/validate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", "validate" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-fac81c5d-fb56-401a-a9e9-e63f5caa13af" }, { "id": "87b5b9cb-195a-4bb1-8f17-7f10b9dd10d3", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"operation\": {\n \"operationType\": \"UPDATE\",\n \"model\": {\n \"campaignEnd\": \"\",\n \"campaignStart\": \"\",\n \"name\": \"\",\n \"type\": \"permanent\",\n \"description\": \"\",\n \"conditionId\": \"\"\n },\n \"resourceId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/validate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", "validate" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-87b5b9cb-195a-4bb1-8f17-7f10b9dd10d3" }, { "id": "c2c0a91d-b390-40ca-8c27-a0487039e6fc", "name": "Too Many Requests (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#429-too_many_requests)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"operation\": {\n \"operationType\": \"UPDATE\",\n \"model\": {\n \"campaignEnd\": \"\",\n \"campaignStart\": \"\",\n \"name\": \"\",\n \"type\": \"permanent\",\n \"description\": \"\",\n \"conditionId\": \"\"\n },\n \"resourceId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/validate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", "validate" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-c2c0a91d-b390-40ca-8c27-a0487039e6fc" } ], "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-1d8dbf04-3c37-4294-bd6b-736d36ac58a9" } ], "id": "da8fc9f3-6080-4a3e-b32f-536654a8cd65", "createdAt": "2026-07-28T01:32:47.000Z", "updatedAt": "2026-07-28T01:32:47.000Z", "uid": "35240-da8fc9f3-6080-4a3e-b32f-536654a8cd65" }, { "name": "{statementGroupId}", "item": [ { "name": "associations", "item": [ { "name": "Update the Rules Associated with a Statement Group", "id": "dea7b16e-18e5-4896-8d78-0bf5eaf59d08", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"toAdd\": [\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n },\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n }\n ],\n \"toRemove\": [\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n },\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId/associations?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", ":statementGroupId", "associations" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "id": "33ddb021-dc81-4ccd-b6d0-b08214e3871c", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." }, { "id": "464d1eec-9c9d-4991-8e5e-5ec9c73d2462", "key": "statementGroupId", "value": "", "description": "(Required) The unique identifier of the statement group." } ] }, "description": "There are two operations which can update the rules associated with a statement group:\n\n- **Addition** uses the `toAdd` parameter\n- **Deletion** uses the `toRemove` parameter\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"EDIT\",\"targetId\":\"{pipelineId}\"}\n```\n
" }, "response": [ { "id": "dc36ff44-7c6d-4769-b4c3-edc24115bdeb", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"toAdd\": [\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n },\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n }\n ],\n \"toRemove\": [\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n },\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId/associations?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", ":statementGroupId", "associations" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementGroupId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"associatedRules\": [\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n },\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-dc36ff44-7c6d-4769-b4c3-edc24115bdeb" }, { "id": "65d7955a-e085-433b-b462-fafddb23c0d2", "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"toAdd\": [\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n },\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n }\n ],\n \"toRemove\": [\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n },\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId/associations?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", ":statementGroupId", "associations" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementGroupId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-65d7955a-e085-433b-b462-fafddb23c0d2" }, { "id": "838c611b-6989-49de-b985-74f24582a211", "name": "Unauthorized (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#401-unauthorized)", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"toAdd\": [\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n },\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n }\n ],\n \"toRemove\": [\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n },\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId/associations?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", ":statementGroupId", "associations" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementGroupId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-838c611b-6989-49de-b985-74f24582a211" }, { "id": "8fb4eb34-aa48-4f1c-b510-1e98877f6368", "name": "Forbidden (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#403-forbidden)", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"toAdd\": [\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n },\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n }\n ],\n \"toRemove\": [\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n },\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId/associations?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", ":statementGroupId", "associations" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementGroupId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-8fb4eb34-aa48-4f1c-b510-1e98877f6368" }, { "id": "05ac96e4-c583-49c4-b54f-904c082e2b80", "name": "Authentication Timeout", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"toAdd\": [\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n },\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n }\n ],\n \"toRemove\": [\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n },\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId/associations?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", ":statementGroupId", "associations" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementGroupId" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-05ac96e4-c583-49c4-b54f-904c082e2b80" }, { "id": "2e328b5e-c519-49db-b9ff-b9dd32969fa9", "name": "The request to update the rules associated with the statement group could not be processed", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"toAdd\": [\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n },\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n }\n ],\n \"toRemove\": [\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n },\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId/associations?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", ":statementGroupId", "associations" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementGroupId" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-2e328b5e-c519-49db-b9ff-b9dd32969fa9" }, { "id": "d11a98c3-3ffc-4ea1-9b86-046a03b5e858", "name": "Too Many Requests (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#429-too_many_requests)", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"toAdd\": [\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n },\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n }\n ],\n \"toRemove\": [\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n },\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId/associations?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", ":statementGroupId", "associations" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementGroupId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-d11a98c3-3ffc-4ea1-9b86-046a03b5e858" }, { "id": "ef877317-7d37-4467-8b02-506efbf7c51f", "name": "Service Unavailable (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#5xx)", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"toAdd\": [\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n },\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n }\n ],\n \"toRemove\": [\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n },\n {\n \"featureType\": \"resultRankings\",\n \"ruleId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId/associations?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", ":statementGroupId", "associations" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementGroupId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-ef877317-7d37-4467-8b02-506efbf7c51f" } ], "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-dea7b16e-18e5-4896-8d78-0bf5eaf59d08" } ], "id": "b0a3a32d-e0bc-434e-9cb3-e0502e4c1191", "createdAt": "2026-07-28T01:32:47.000Z", "updatedAt": "2026-07-28T01:32:47.000Z", "uid": "35240-b0a3a32d-e0bc-434e-9cb3-e0502e4c1191" }, { "name": "Get a Statement Group of a Pipeline", "id": "aaecec41-1349-4298-9323-4eee9094dcb4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", ":statementGroupId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "id": "dd5713d1-af51-4f86-9e26-4d6820ac67ca", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." }, { "id": "8d6c48ce-0b08-4f4d-8670-1a5a135ea19c", "key": "statementGroupId", "value": "", "description": "(Required) The unique identifier of the statement group." } ] }, "description": "Get a statement group of a pipeline\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"VIEW\",\"targetId\":\"{pipelineId}\"}\n```\n
" }, "response": [ { "id": "78628de8-895d-486e-a2d3-16f66489d52a", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", ":statementGroupId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementGroupId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"type\": \"permanent\",\n \"name\": \"\",\n \"statementComposition\": {\n \"otherStatementCount\": \"\",\n \"resultRankingStatementCount\": \"\"\n },\n \"createdAt\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"conditionId\": \"\",\n \"conditionDefinition\": \"\",\n \"conditionDetailed\": {\n \"description\": \"A structured representation of the condition.\"\n },\n \"createdBy\": \"\",\n \"modifiedAt\": \"\",\n \"modifiedBy\": \"\",\n \"campaignStart\": \"\",\n \"campaignEnd\": \"\",\n \"status\": \"active\"\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-78628de8-895d-486e-a2d3-16f66489d52a" }, { "id": "76fd3197-7ff4-487f-b7a3-5632ce178e40", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", ":statementGroupId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementGroupId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-76fd3197-7ff4-487f-b7a3-5632ce178e40" }, { "id": "38eaf9a8-5433-46dc-a6a0-574767de0d8d", "name": "Unauthorized (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#401-unauthorized)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", ":statementGroupId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementGroupId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-38eaf9a8-5433-46dc-a6a0-574767de0d8d" }, { "id": "289bcd48-0a79-4707-addb-6cb09b243802", "name": "Forbidden (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#403-forbidden)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", ":statementGroupId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementGroupId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-289bcd48-0a79-4707-addb-6cb09b243802" }, { "id": "8b02b79b-abba-458f-9139-d38e30c02a95", "name": "Authentication Timeout", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", ":statementGroupId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementGroupId" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-8b02b79b-abba-458f-9139-d38e30c02a95" }, { "id": "562c2073-0997-4f40-892c-9fb1136c4d8d", "name": "Too Many Requests (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#429-too_many_requests)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", ":statementGroupId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementGroupId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-562c2073-0997-4f40-892c-9fb1136c4d8d" }, { "id": "6b45f807-a3a6-4770-ab5a-0f273394cd05", "name": "Service Unavailable (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#5xx)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", ":statementGroupId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementGroupId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-6b45f807-a3a6-4770-ab5a-0f273394cd05" } ], "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-aaecec41-1349-4298-9323-4eee9094dcb4" }, { "name": "Delete a Statement Group of a Pipeline", "id": "8d02dd4b-9786-4dd9-a525-11bdd76f856d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", ":statementGroupId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "id": "007009a5-cd16-4e8f-b2fa-cf5f9df4b289", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." }, { "id": "519bd58d-1ba8-47c9-836f-b1e0e4f8eae4", "key": "statementGroupId", "value": "", "description": "(Required) The unique identifier of the statement group." } ] }, "description": "Delete a statement group of a pipeline\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"EDIT\",\"targetId\":\"{pipelineId}\"}\n```\n
" }, "response": [ { "id": "69bb255e-a1c5-4a10-bb3b-8c8f2d32ebe0", "name": "No response", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", ":statementGroupId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementGroupId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-69bb255e-a1c5-4a10-bb3b-8c8f2d32ebe0" }, { "id": "4216f612-edcd-4f91-acfb-a8be940efd6a", "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", ":statementGroupId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementGroupId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-4216f612-edcd-4f91-acfb-a8be940efd6a" }, { "id": "2c0a2fac-d606-4e28-8a86-b877903e4fd3", "name": "Unauthorized (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#401-unauthorized)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", ":statementGroupId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementGroupId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-2c0a2fac-d606-4e28-8a86-b877903e4fd3" }, { "id": "14633ebf-d9d0-4314-aa1a-0836e712554b", "name": "Forbidden (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#403-forbidden)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", ":statementGroupId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementGroupId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-14633ebf-d9d0-4314-aa1a-0836e712554b" }, { "id": "606e20b6-9412-481f-8c5a-7d56d90e9b3b", "name": "Authentication Timeout", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", ":statementGroupId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementGroupId" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-606e20b6-9412-481f-8c5a-7d56d90e9b3b" }, { "id": "0d39c09e-f7f3-4dc0-9bf3-f7cdfaf7d39b", "name": "Unprocessable Entity", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", ":statementGroupId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementGroupId" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-0d39c09e-f7f3-4dc0-9bf3-f7cdfaf7d39b" }, { "id": "f4053eb4-70e0-4e35-bd31-4745cefa05a3", "name": "Too Many Requests (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#429-too_many_requests)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", ":statementGroupId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementGroupId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-f4053eb4-70e0-4e35-bd31-4745cefa05a3" }, { "id": "40062de3-5a2c-48da-9dc3-b332fb1a8111", "name": "Service Unavailable (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#5xx)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", ":statementGroupId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementGroupId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-40062de3-5a2c-48da-9dc3-b332fb1a8111" } ], "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-8d02dd4b-9786-4dd9-a525-11bdd76f856d" }, { "name": "Update a Statement Group", "id": "a5fe39cd-c633-494a-aa56-f2c68d5763c4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"campaignEnd\": \"\",\n \"campaignStart\": \"\",\n \"name\": \"\",\n \"type\": \"campaign\",\n \"description\": \"\",\n \"conditionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", ":statementGroupId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "id": "4d259bae-50d1-48cf-a380-c4e3ba71fe4a", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." }, { "id": "8d4bdeab-d1ef-46cb-9936-110d2555c519", "key": "statementGroupId", "value": "", "description": "(Required) The unique identifier of the statement group." } ] }, "description": "Update a statement group\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"EDIT\",\"targetId\":\"{pipelineId}\"}\n```\n
" }, "response": [ { "id": "d556a182-5600-4165-83ff-6074cc0e9b56", "name": "No Content", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"campaignEnd\": \"\",\n \"campaignStart\": \"\",\n \"name\": \"\",\n \"type\": \"campaign\",\n \"description\": \"\",\n \"conditionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", ":statementGroupId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementGroupId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-d556a182-5600-4165-83ff-6074cc0e9b56" }, { "id": "3e291dea-fd8b-4109-ac4c-9dbba3a0101d", "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"campaignEnd\": \"\",\n \"campaignStart\": \"\",\n \"name\": \"\",\n \"type\": \"campaign\",\n \"description\": \"\",\n \"conditionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", ":statementGroupId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementGroupId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-3e291dea-fd8b-4109-ac4c-9dbba3a0101d" }, { "id": "83d670ab-126c-4a36-8784-913554ea402d", "name": "Unauthorized (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#401-unauthorized)", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"campaignEnd\": \"\",\n \"campaignStart\": \"\",\n \"name\": \"\",\n \"type\": \"campaign\",\n \"description\": \"\",\n \"conditionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", ":statementGroupId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementGroupId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-83d670ab-126c-4a36-8784-913554ea402d" }, { "id": "f5de0a06-24b7-4d66-8163-89a53770c702", "name": "Forbidden (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#403-forbidden)", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"campaignEnd\": \"\",\n \"campaignStart\": \"\",\n \"name\": \"\",\n \"type\": \"campaign\",\n \"description\": \"\",\n \"conditionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", ":statementGroupId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementGroupId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-f5de0a06-24b7-4d66-8163-89a53770c702" }, { "id": "cb8cbf9a-ec9d-4c4e-a16d-cda8f5bef0f4", "name": "Authentication Timeout", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"campaignEnd\": \"\",\n \"campaignStart\": \"\",\n \"name\": \"\",\n \"type\": \"campaign\",\n \"description\": \"\",\n \"conditionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", ":statementGroupId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementGroupId" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-cb8cbf9a-ec9d-4c4e-a16d-cda8f5bef0f4" }, { "id": "929ae916-41cd-47f2-ae68-18251e1b6f7c", "name": "Unprocessable Entity", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"campaignEnd\": \"\",\n \"campaignStart\": \"\",\n \"name\": \"\",\n \"type\": \"campaign\",\n \"description\": \"\",\n \"conditionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", ":statementGroupId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementGroupId" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-929ae916-41cd-47f2-ae68-18251e1b6f7c" }, { "id": "a87a9d24-e13a-4c36-924a-dc1896aaf185", "name": "Too Many Requests (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#429-too_many_requests)", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"campaignEnd\": \"\",\n \"campaignStart\": \"\",\n \"name\": \"\",\n \"type\": \"campaign\",\n \"description\": \"\",\n \"conditionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", ":statementGroupId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementGroupId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-a87a9d24-e13a-4c36-924a-dc1896aaf185" }, { "id": "896bb2bf-42c1-4441-b136-8036cc194592", "name": "Service Unavailable (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#5xx)", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"campaignEnd\": \"\",\n \"campaignStart\": \"\",\n \"name\": \"\",\n \"type\": \"campaign\",\n \"description\": \"\",\n \"conditionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", ":statementGroupId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementGroupId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-896bb2bf-42c1-4441-b136-8036cc194592" } ], "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-a5fe39cd-c633-494a-aa56-f2c68d5763c4" }, { "name": "Toggle a Permanent Group", "id": "9250d869-8dbb-481d-8a07-19c7852be4bc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"isActive\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", ":statementGroupId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "id": "1f3c65b3-c16a-492f-921d-3ae573da35e3", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." }, { "id": "e09f59e6-45f8-4fca-99d5-2f84aaafbca1", "key": "statementGroupId", "value": "", "description": "(Required) The unique identifier of the statement group." } ] }, "description": "Toggle a permanent group\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"EDIT\",\"targetId\":\"{pipelineId}\"}\n```\n
" }, "response": [ { "id": "73765f87-2fb3-4ffa-a8a2-9c4fa5f2c86e", "name": "No Content", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"isActive\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", ":statementGroupId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementGroupId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-73765f87-2fb3-4ffa-a8a2-9c4fa5f2c86e" }, { "id": "4b0ad0c5-6058-407d-9152-9246e63b7fac", "name": "Bad Request", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"isActive\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", ":statementGroupId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementGroupId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-4b0ad0c5-6058-407d-9152-9246e63b7fac" }, { "id": "40eef78d-818d-4364-a0a9-31127467920d", "name": "Unauthorized (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#401-unauthorized)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"isActive\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", ":statementGroupId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementGroupId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-40eef78d-818d-4364-a0a9-31127467920d" }, { "id": "94c2bed4-7290-4bd2-9e08-e8ab7f2f9872", "name": "Forbidden (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#403-forbidden)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"isActive\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", ":statementGroupId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementGroupId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-94c2bed4-7290-4bd2-9e08-e8ab7f2f9872" }, { "id": "257ae15b-dfa3-4230-829d-b8bc54d938a1", "name": "Authentication Timeout", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"isActive\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", ":statementGroupId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementGroupId" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-257ae15b-dfa3-4230-829d-b8bc54d938a1" }, { "id": "d845b29d-ed80-44b0-90ac-558407ba8fe9", "name": "Unprocessable Entity", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"isActive\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", ":statementGroupId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementGroupId" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-d845b29d-ed80-44b0-90ac-558407ba8fe9" }, { "id": "4086d789-0e31-4d56-8748-e266d3ee6dbf", "name": "Too Many Requests (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#429-too_many_requests)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"isActive\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", ":statementGroupId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementGroupId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-4086d789-0e31-4d56-8748-e266d3ee6dbf" }, { "id": "2676e6e2-cf02-4727-a484-60e3d1055bfb", "name": "Service Unavailable (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#5xx)", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"isActive\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups/:statementGroupId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups", ":statementGroupId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementGroupId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-2676e6e2-cf02-4727-a484-60e3d1055bfb" } ], "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-9250d869-8dbb-481d-8a07-19c7852be4bc" } ], "id": "b3235bbf-e6c4-4d73-82f0-7627f222f053", "createdAt": "2026-07-28T01:32:47.000Z", "updatedAt": "2026-07-28T01:32:47.000Z", "uid": "35240-b3235bbf-e6c4-4d73-82f0-7627f222f053" }, { "name": "List Statement Groups of a Pipeline", "id": "44f45000-46c0-4fb6-9a58-a4a285bd4f4a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups?organizationId=&page=0&perPage=20&filter=&sortBy=status&isOrderAscending=true&types=&status=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" }, { "description": "The query filter to match.\n\nThis allows you to search within query pipeline statement definitions and descriptions.\n\nBy default, results are not required to match a specific query filter.", "key": "filter", "value": "" }, { "description": "The sort criteria to apply on the results.\n\n`name` : Sort results in alphabetical order\n\n`status`: Sort results according to their activation status (i.e., `Active`, `Inactive`, `Not Yet Started`, `Expire`)", "key": "sortBy", "value": "status" }, { "description": "Whether to sort the results in ascending order.", "key": "isOrderAscending", "value": "true" }, { "description": "The type name of the statement group.", "key": "types", "value": "" }, { "description": "The status of the statement group.", "key": "status", "value": "" } ], "variable": [ { "id": "1f9e9649-fb68-4bf3-950f-fe2c558534fa", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." } ] }, "description": "List statement groups of a pipeline\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"VIEW\",\"targetId\":\"{pipelineId}\"}\n```\n
" }, "response": [ { "id": "8a1566cf-e16e-4383-b8f7-087fd3be4226", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups?organizationId=&page=0&perPage=20&filter=&sortBy=status&isOrderAscending=true&types=&status=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" }, { "description": "The query filter to match.\n\nThis allows you to search within query pipeline statement definitions and descriptions.\n\nBy default, results are not required to match a specific query filter.", "key": "filter", "value": "" }, { "description": "The sort criteria to apply on the results.\n\n`name` : Sort results in alphabetical order\n\n`status`: Sort results according to their activation status (i.e., `Active`, `Inactive`, `Not Yet Started`, `Expire`)", "key": "sortBy", "value": "status" }, { "description": "Whether to sort the results in ascending order.", "key": "isOrderAscending", "value": "true" }, { "description": "The type name of the statement group.", "key": "types", "value": "" }, { "description": "The status of the statement group.", "key": "status", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"groupComposition\": {\n \"campaignGroupCount\": \"\",\n \"permanentGroupCount\": \"\",\n \"activeGroupCount\": \"\",\n \"inactiveGroupCount\": \"\",\n \"expiredGroupCount\": \"\",\n \"notStartedGroupCount\": \"\"\n },\n \"groups\": [\n {\n \"id\": \"\",\n \"type\": \"permanent\",\n \"name\": \"\",\n \"statementComposition\": {\n \"otherStatementCount\": \"\",\n \"resultRankingStatementCount\": \"\"\n },\n \"createdAt\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"conditionId\": \"\",\n \"conditionDefinition\": \"\",\n \"conditionDetailed\": {\n \"description\": \"A structured representation of the condition.\"\n },\n \"createdBy\": \"\",\n \"modifiedAt\": \"\",\n \"modifiedBy\": \"\",\n \"campaignStart\": \"\",\n \"campaignEnd\": \"\",\n \"status\": \"notStarted\"\n },\n {\n \"id\": \"\",\n \"type\": \"permanent\",\n \"name\": \"\",\n \"statementComposition\": {\n \"otherStatementCount\": \"\",\n \"resultRankingStatementCount\": \"\"\n },\n \"createdAt\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"conditionId\": \"\",\n \"conditionDefinition\": \"\",\n \"conditionDetailed\": {\n \"description\": \"A structured representation of the condition.\"\n },\n \"createdBy\": \"\",\n \"modifiedAt\": \"\",\n \"modifiedBy\": \"\",\n \"campaignStart\": \"\",\n \"campaignEnd\": \"\",\n \"status\": \"active\"\n }\n ],\n \"totalCount\": \"\"\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-8a1566cf-e16e-4383-b8f7-087fd3be4226" }, { "id": "ae27e1bc-2aba-40ef-b0ff-f5849e5b415b", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups?organizationId=&page=0&perPage=20&filter=&sortBy=status&isOrderAscending=true&types=&status=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" }, { "description": "The query filter to match.\n\nThis allows you to search within query pipeline statement definitions and descriptions.\n\nBy default, results are not required to match a specific query filter.", "key": "filter", "value": "" }, { "description": "The sort criteria to apply on the results.\n\n`name` : Sort results in alphabetical order\n\n`status`: Sort results according to their activation status (i.e., `Active`, `Inactive`, `Not Yet Started`, `Expire`)", "key": "sortBy", "value": "status" }, { "description": "Whether to sort the results in ascending order.", "key": "isOrderAscending", "value": "true" }, { "description": "The type name of the statement group.", "key": "types", "value": "" }, { "description": "The status of the statement group.", "key": "status", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-ae27e1bc-2aba-40ef-b0ff-f5849e5b415b" }, { "id": "32d9c8d4-98f6-487f-984f-68798b03406c", "name": "Unauthorized (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#401-unauthorized)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups?organizationId=&page=0&perPage=20&filter=&sortBy=status&isOrderAscending=true&types=&status=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" }, { "description": "The query filter to match.\n\nThis allows you to search within query pipeline statement definitions and descriptions.\n\nBy default, results are not required to match a specific query filter.", "key": "filter", "value": "" }, { "description": "The sort criteria to apply on the results.\n\n`name` : Sort results in alphabetical order\n\n`status`: Sort results according to their activation status (i.e., `Active`, `Inactive`, `Not Yet Started`, `Expire`)", "key": "sortBy", "value": "status" }, { "description": "Whether to sort the results in ascending order.", "key": "isOrderAscending", "value": "true" }, { "description": "The type name of the statement group.", "key": "types", "value": "" }, { "description": "The status of the statement group.", "key": "status", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-32d9c8d4-98f6-487f-984f-68798b03406c" }, { "id": "30fd4f27-4d94-46c5-944f-12df80c33914", "name": "Forbidden (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#403-forbidden)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups?organizationId=&page=0&perPage=20&filter=&sortBy=status&isOrderAscending=true&types=&status=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" }, { "description": "The query filter to match.\n\nThis allows you to search within query pipeline statement definitions and descriptions.\n\nBy default, results are not required to match a specific query filter.", "key": "filter", "value": "" }, { "description": "The sort criteria to apply on the results.\n\n`name` : Sort results in alphabetical order\n\n`status`: Sort results according to their activation status (i.e., `Active`, `Inactive`, `Not Yet Started`, `Expire`)", "key": "sortBy", "value": "status" }, { "description": "Whether to sort the results in ascending order.", "key": "isOrderAscending", "value": "true" }, { "description": "The type name of the statement group.", "key": "types", "value": "" }, { "description": "The status of the statement group.", "key": "status", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-30fd4f27-4d94-46c5-944f-12df80c33914" }, { "id": "59d04b4c-eb71-4a51-a9f1-608306e995fc", "name": "Authentication Timeout", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups?organizationId=&page=0&perPage=20&filter=&sortBy=status&isOrderAscending=true&types=&status=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" }, { "description": "The query filter to match.\n\nThis allows you to search within query pipeline statement definitions and descriptions.\n\nBy default, results are not required to match a specific query filter.", "key": "filter", "value": "" }, { "description": "The sort criteria to apply on the results.\n\n`name` : Sort results in alphabetical order\n\n`status`: Sort results according to their activation status (i.e., `Active`, `Inactive`, `Not Yet Started`, `Expire`)", "key": "sortBy", "value": "status" }, { "description": "Whether to sort the results in ascending order.", "key": "isOrderAscending", "value": "true" }, { "description": "The type name of the statement group.", "key": "types", "value": "" }, { "description": "The status of the statement group.", "key": "status", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-59d04b4c-eb71-4a51-a9f1-608306e995fc" }, { "id": "3451d544-b0e7-4e37-8413-0e97edb9ffe5", "name": "Too Many Requests (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#429-too_many_requests)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups?organizationId=&page=0&perPage=20&filter=&sortBy=status&isOrderAscending=true&types=&status=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" }, { "description": "The query filter to match.\n\nThis allows you to search within query pipeline statement definitions and descriptions.\n\nBy default, results are not required to match a specific query filter.", "key": "filter", "value": "" }, { "description": "The sort criteria to apply on the results.\n\n`name` : Sort results in alphabetical order\n\n`status`: Sort results according to their activation status (i.e., `Active`, `Inactive`, `Not Yet Started`, `Expire`)", "key": "sortBy", "value": "status" }, { "description": "Whether to sort the results in ascending order.", "key": "isOrderAscending", "value": "true" }, { "description": "The type name of the statement group.", "key": "types", "value": "" }, { "description": "The status of the statement group.", "key": "status", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-3451d544-b0e7-4e37-8413-0e97edb9ffe5" } ], "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-44f45000-46c0-4fb6-9a58-a4a285bd4f4a" }, { "name": "Create a New Statement Group", "id": "8e716248-601e-4859-bb93-f5859d21811d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"campaignEnd\": \"\",\n \"campaignStart\": \"\",\n \"name\": \"\",\n \"type\": \"campaign\",\n \"description\": \"\",\n \"conditionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "id": "9c9ab9ba-adfa-4bf3-80fc-f77cba359dae", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." } ] }, "description": "Create a new statement group\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"EDIT\",\"targetId\":\"{pipelineId}\"}\n```\n
" }, "response": [ { "id": "fedcada8-e627-4b8f-a950-e9abbb7525b3", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"campaignEnd\": \"\",\n \"campaignStart\": \"\",\n \"name\": \"\",\n \"type\": \"campaign\",\n \"description\": \"\",\n \"conditionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"campaign\",\n \"isActive\": \"\",\n \"campaignStart\": \"\",\n \"campaignEnd\": \"\",\n \"description\": \"\",\n \"conditionId\": \"\"\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-fedcada8-e627-4b8f-a950-e9abbb7525b3" }, { "id": "6d9beb07-4953-4753-8db5-6ab9675aeef4", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"campaignEnd\": \"\",\n \"campaignStart\": \"\",\n \"name\": \"\",\n \"type\": \"campaign\",\n \"description\": \"\",\n \"conditionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-6d9beb07-4953-4753-8db5-6ab9675aeef4" }, { "id": "3bc7ac1a-8bc0-4ebf-8b25-2a5d5cb8d008", "name": "Unauthorized (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#401-unauthorized)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"campaignEnd\": \"\",\n \"campaignStart\": \"\",\n \"name\": \"\",\n \"type\": \"campaign\",\n \"description\": \"\",\n \"conditionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-3bc7ac1a-8bc0-4ebf-8b25-2a5d5cb8d008" }, { "id": "906ff2a1-9a13-474c-9a28-406bea18dc71", "name": "Forbidden (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#403-forbidden)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"campaignEnd\": \"\",\n \"campaignStart\": \"\",\n \"name\": \"\",\n \"type\": \"campaign\",\n \"description\": \"\",\n \"conditionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-906ff2a1-9a13-474c-9a28-406bea18dc71" }, { "id": "26872d8d-6b85-4b4e-b675-561370ea429f", "name": "Authentication Timeout", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"campaignEnd\": \"\",\n \"campaignStart\": \"\",\n \"name\": \"\",\n \"type\": \"campaign\",\n \"description\": \"\",\n \"conditionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-26872d8d-6b85-4b4e-b675-561370ea429f" }, { "id": "b2d5325f-da1c-44ab-9586-999eab479a51", "name": "Too Many Requests (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#429-too_many_requests)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"campaignEnd\": \"\",\n \"campaignStart\": \"\",\n \"name\": \"\",\n \"type\": \"campaign\",\n \"description\": \"\",\n \"conditionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statementGroups?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statementGroups" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"in_3\": -74554383\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-b2d5325f-da1c-44ab-9586-999eab479a51" } ], "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-8e716248-601e-4859-bb93-f5859d21811d" } ], "id": "15401a37-dc90-45aa-94e9-cc0775f27126", "createdAt": "2026-07-28T01:32:47.000Z", "updatedAt": "2026-07-28T01:32:47.000Z", "uid": "35240-15401a37-dc90-45aa-94e9-cc0775f27126" } ], "id": "97ad1a89-ed60-4b05-ba16-5b40fe9611d4", "createdAt": "2026-07-28T01:32:47.000Z", "updatedAt": "2026-07-28T01:32:47.000Z", "uid": "35240-97ad1a89-ed60-4b05-ba16-5b40fe9611d4" } ], "id": "040d5312-0ab4-454b-88dc-6e532ad7caeb", "createdAt": "2026-07-28T01:32:47.000Z", "updatedAt": "2026-07-28T01:32:47.000Z", "uid": "35240-040d5312-0ab4-454b-88dc-6e532ad7caeb" } ], "id": "2aabae06-f11d-46e2-be5f-6b23202c308e", "createdAt": "2026-07-28T01:32:47.000Z", "updatedAt": "2026-07-28T01:32:47.000Z", "uid": "35240-2aabae06-f11d-46e2-be5f-6b23202c308e" } ], "id": "5e9f44f3-b9f6-4029-a983-c941216efff0", "createdAt": "2026-07-28T01:32:47.000Z", "updatedAt": "2026-07-28T01:32:47.000Z", "uid": "35240-5e9f44f3-b9f6-4029-a983-c941216efff0" }, { "name": "admin", "item": [ { "name": "pipelines", "item": [ { "name": "featureActiveState", "item": [ { "name": "Returns the List of All Pipeline Features and Whether They're Active or Not.", "id": "a84cce75-8a82-4ea5-a995-80bee348a508", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/search/admin/pipelines/featureActiveState?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "admin", "pipelines", "featureActiveState" ], "query": [ { "description": "(Required) The unique identifier of the target Coveo Cloud organization.", "key": "organizationId", "value": "" } ] }, "description": "
\nPrivilege(s) required\n\n```json\n\n```\n
" }, "response": [ { "id": "7b43fa01-47d4-43a1-8bf3-515e550bee49", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/admin/pipelines/featureActiveState?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "admin", "pipelines", "featureActiveState" ], "query": [ { "description": "(Required) The unique identifier of the target Coveo Cloud organization.", "key": "organizationId", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"featureActiveState\": [\n {\n \"feature\": \"\",\n \"active\": \"\"\n },\n {\n \"feature\": \"\",\n \"active\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-7b43fa01-47d4-43a1-8bf3-515e550bee49" } ], "createdAt": "2026-07-28T01:32:48.000Z", "updatedAt": "2026-07-28T01:32:48.000Z", "uid": "35240-a84cce75-8a82-4ea5-a995-80bee348a508" } ], "id": "91f7ad5b-b6c6-46de-ae20-ad966b873048", "createdAt": "2026-07-28T01:32:47.000Z", "updatedAt": "2026-07-28T01:32:47.000Z", "uid": "35240-91f7ad5b-b6c6-46de-ae20-ad966b873048" } ], "id": "86bc9d1b-e640-4ab6-b8d3-954ace0fbb73", "createdAt": "2026-07-28T01:32:47.000Z", "updatedAt": "2026-07-28T01:32:47.000Z", "uid": "35240-86bc9d1b-e640-4ab6-b8d3-954ace0fbb73" } ], "id": "136b29aa-f08e-4c5a-8a6f-f914df1c9112", "createdAt": "2026-07-28T01:32:47.000Z", "updatedAt": "2026-07-28T01:32:47.000Z", "uid": "35240-136b29aa-f08e-4c5a-8a6f-f914df1c9112" } ], "id": "834b7a99-336a-400d-a98c-a9b2fddd352e", "createdAt": "2026-07-28T01:32:47.000Z", "updatedAt": "2026-07-28T01:32:47.000Z", "uid": "35240-834b7a99-336a-400d-a98c-a9b2fddd352e" } ], "id": "935b58ba-fcba-4bc6-abc5-450fd2e7102e", "createdAt": "2026-07-28T01:32:47.000Z", "updatedAt": "2026-07-28T01:32:47.000Z", "uid": "35240-935b58ba-fcba-4bc6-abc5-450fd2e7102e" } ], "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" } ] }