{ "info": { "_postman_id": "e3b898a8-2d6d-4d4d-ad39-eea90ea4e7b8", "name": "Coveo Activity Activities Fields 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:28:31.000Z", "updatedAt": "2026-07-28T01:28:31.000Z", "lastUpdatedBy": "35240", "uid": "35240-e3b898a8-2d6d-4d4d-ad39-eea90ea4e7b8" }, "item": [ { "name": "rest", "item": [ { "name": "organizations", "item": [ { "name": "{organizationId}", "item": [ { "name": "indexes", "item": [ { "name": "fields", "item": [ { "name": "{fieldId}", "item": [ { "name": "Show Field", "id": "70bf412d-3a71-4580-85b7-949b162f22a4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/indexes/fields/:fieldId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "indexes", "fields", ":fieldId" ], "variable": [ { "id": "ba47062a-b70d-42ec-a143-ef66a92cfe75", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
Example: `mycoveocloudv2organizationg8tp8wu3`" }, { "id": "5a64a427-a7e5-409c-8912-18964a539eb4", "key": "fieldId", "value": "", "description": "(Required) The `name` property of the field to retrieve.
**Example:** `numberoflikes`" } ] }, "description": "Shows information regarding a single [field](https://docs.coveo.com/en/200/glossary/field) in the [index](https://docs.coveo.com/en/204/glossary/index) of the target [Coveo Cloud organization](https://docs.coveo.com/en/185/).

**Required privilege:** Fields - View

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"FIELD\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "281be7e5-4bb2-4e69-9495-5613d9b8dbe4", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/indexes/fields/:fieldId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "indexes", "fields", ":fieldId" ], "variable": [ { "key": "organizationId" }, { "key": "fieldId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"name\": \"\",\n \"description\": \"\",\n \"label\": \"\",\n \"automaticFacetsCandidate\": false,\n \"automaticFacetsCandidateTags\": [\n \"\",\n \"\"\n ],\n \"type\": \"VECTOR\",\n \"includeInQuery\": true,\n \"includeInResults\": true,\n \"keyValue\": false,\n \"multilingual\": false,\n \"keepAccentsDisplayValueFacet\": false,\n \"keepDistinctDisplayValueFacet\": false,\n \"mergeWithLexicon\": false,\n \"smartDateFacet\": false,\n \"facet\": \"\",\n \"multiValueFacet\": false,\n \"hierarchicalFacet\": false,\n \"sort\": \"\",\n \"ranking\": false,\n \"stemming\": false,\n \"multiValueFacetTokenizers\": \"\",\n \"useCacheForNestedQuery\": false,\n \"useCacheForSort\": false,\n \"useCacheForNumericQuery\": false,\n \"useCacheForComputedFacet\": false,\n \"dateFormat\": \"\",\n \"system\": \"\",\n \"projectIds\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:28:32.000Z", "updatedAt": "2026-07-28T01:28:32.000Z", "uid": "35240-281be7e5-4bb2-4e69-9495-5613d9b8dbe4" } ], "createdAt": "2026-07-28T01:28:32.000Z", "updatedAt": "2026-07-28T01:28:32.000Z", "uid": "35240-70bf412d-3a71-4580-85b7-949b162f22a4" }, { "name": "Update Field", "id": "ad63b270-60b3-4309-904f-14a3d97c3f5f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"label\": \"\",\n \"automaticFacetsCandidate\": false,\n \"automaticFacetsCandidateTags\": [\n \"\",\n \"\"\n ],\n \"type\": \"VECTOR\",\n \"includeInQuery\": true,\n \"includeInResults\": true,\n \"keyValue\": false,\n \"multilingual\": false,\n \"keepAccentsDisplayValueFacet\": false,\n \"keepDistinctDisplayValueFacet\": false,\n \"mergeWithLexicon\": false,\n \"smartDateFacet\": false,\n \"facet\": \"\",\n \"multiValueFacet\": false,\n \"hierarchicalFacet\": false,\n \"sort\": \"\",\n \"ranking\": false,\n \"stemming\": false,\n \"multiValueFacetTokenizers\": \"\",\n \"useCacheForNestedQuery\": false,\n \"useCacheForSort\": false,\n \"useCacheForNumericQuery\": false,\n \"useCacheForComputedFacet\": false,\n \"dateFormat\": \"\",\n \"system\": \"\",\n \"projectIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/indexes/fields/:fieldId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "indexes", "fields", ":fieldId" ], "variable": [ { "id": "dba59ed5-e27b-447e-a893-d7fd8d8f3bd5", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
Example: `mycoveocloudv2organizationg8tp8wu3`" }, { "id": "5c4ac6c2-34de-48aa-8cb5-3caa1574eef8", "key": "fieldId", "value": "", "description": "(Required) The `name` property of the field to update.
**Example:** `numberoflikes`" } ] }, "description": "Updates an existing [field](https://docs.coveo.com/en/200/glossary/field) in the [index](https://docs.coveo.com/en/204/glossary/index) of the target [Coveo Cloud organization](https://docs.coveo.com/en/185/).

**Required privilege:** Fields - Edit

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"FIELD\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "40bbf26e-50fb-434e-88cb-2747fdd02fde", "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 \"name\": \"\",\n \"description\": \"\",\n \"label\": \"\",\n \"automaticFacetsCandidate\": false,\n \"automaticFacetsCandidateTags\": [\n \"\",\n \"\"\n ],\n \"type\": \"VECTOR\",\n \"includeInQuery\": true,\n \"includeInResults\": true,\n \"keyValue\": false,\n \"multilingual\": false,\n \"keepAccentsDisplayValueFacet\": false,\n \"keepDistinctDisplayValueFacet\": false,\n \"mergeWithLexicon\": false,\n \"smartDateFacet\": false,\n \"facet\": \"\",\n \"multiValueFacet\": false,\n \"hierarchicalFacet\": false,\n \"sort\": \"\",\n \"ranking\": false,\n \"stemming\": false,\n \"multiValueFacetTokenizers\": \"\",\n \"useCacheForNestedQuery\": false,\n \"useCacheForSort\": false,\n \"useCacheForNumericQuery\": false,\n \"useCacheForComputedFacet\": false,\n \"dateFormat\": \"\",\n \"system\": \"\",\n \"projectIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/indexes/fields/:fieldId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "indexes", "fields", ":fieldId" ], "variable": [ { "key": "organizationId" }, { "key": "fieldId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:28:32.000Z", "updatedAt": "2026-07-28T01:28:32.000Z", "uid": "35240-40bbf26e-50fb-434e-88cb-2747fdd02fde" } ], "createdAt": "2026-07-28T01:28:32.000Z", "updatedAt": "2026-07-28T01:28:32.000Z", "uid": "35240-ad63b270-60b3-4309-904f-14a3d97c3f5f" }, { "name": "Delete Field", "id": "a6c3d11c-e1f1-4f06-aea9-e0e97229adc6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/indexes/fields/:fieldId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "indexes", "fields", ":fieldId" ], "variable": [ { "id": "d6df6cd4-91bb-40ad-84be-4ef59ba402fd", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
Example: `mycoveocloudv2organizationg8tp8wu3`" }, { "id": "5f68bf86-1795-4d50-8baf-4b565a9b0214", "key": "fieldId", "value": "", "description": "(Required) The `name` property of the field to delete.
**Example:** `numberoflikes`" } ] }, "description": "Deletes a [field](https://docs.coveo.com/en/200/glossary/field) in the [index](https://docs.coveo.com/en/204/glossary/index) of the target [Coveo Cloud organization](https://docs.coveo.com/en/185/).

**Required privilege:** Fields - Edit

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"FIELD\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "ddaf2eb7-a3ae-4c37-a312-cb06981ea41a", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/indexes/fields/:fieldId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "indexes", "fields", ":fieldId" ], "variable": [ { "key": "organizationId" }, { "key": "fieldId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:28:32.000Z", "updatedAt": "2026-07-28T01:28:32.000Z", "uid": "35240-ddaf2eb7-a3ae-4c37-a312-cb06981ea41a" } ], "createdAt": "2026-07-28T01:28:32.000Z", "updatedAt": "2026-07-28T01:28:32.000Z", "uid": "35240-a6c3d11c-e1f1-4f06-aea9-e0e97229adc6" } ], "id": "2e984040-575e-430e-b41a-dcc8c7ad0e17", "createdAt": "2026-07-28T01:28:32.000Z", "updatedAt": "2026-07-28T01:28:32.000Z", "uid": "35240-2e984040-575e-430e-b41a-dcc8c7ad0e17" }, { "name": "batch", "item": [ { "name": "update", "item": [ { "name": "results", "item": [ { "name": "Update Fields with Individual Results", "id": "96eff9c9-4611-46ec-86bd-3c9036871f4a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "body": { "mode": "raw", "raw": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"label\": \"\",\n \"automaticFacetsCandidate\": false,\n \"automaticFacetsCandidateTags\": [\n \"\",\n \"\"\n ],\n \"type\": \"DATE\",\n \"includeInQuery\": true,\n \"includeInResults\": true,\n \"keyValue\": false,\n \"multilingual\": false,\n \"keepAccentsDisplayValueFacet\": false,\n \"keepDistinctDisplayValueFacet\": false,\n \"mergeWithLexicon\": false,\n \"smartDateFacet\": false,\n \"facet\": \"\",\n \"multiValueFacet\": false,\n \"hierarchicalFacet\": false,\n \"sort\": \"\",\n \"ranking\": false,\n \"stemming\": false,\n \"multiValueFacetTokenizers\": \"\",\n \"useCacheForNestedQuery\": false,\n \"useCacheForSort\": false,\n \"useCacheForNumericQuery\": false,\n \"useCacheForComputedFacet\": false,\n \"dateFormat\": \"\",\n \"system\": \"\",\n \"projectIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"label\": \"\",\n \"automaticFacetsCandidate\": false,\n \"automaticFacetsCandidateTags\": [\n \"\",\n \"\"\n ],\n \"type\": \"DATE\",\n \"includeInQuery\": true,\n \"includeInResults\": true,\n \"keyValue\": false,\n \"multilingual\": false,\n \"keepAccentsDisplayValueFacet\": false,\n \"keepDistinctDisplayValueFacet\": false,\n \"mergeWithLexicon\": false,\n \"smartDateFacet\": false,\n \"facet\": \"\",\n \"multiValueFacet\": false,\n \"hierarchicalFacet\": false,\n \"sort\": \"\",\n \"ranking\": false,\n \"stemming\": false,\n \"multiValueFacetTokenizers\": \"\",\n \"useCacheForNestedQuery\": false,\n \"useCacheForSort\": false,\n \"useCacheForNumericQuery\": false,\n \"useCacheForComputedFacet\": false,\n \"dateFormat\": \"\",\n \"system\": \"\",\n \"projectIds\": [\n \"\",\n \"\"\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/indexes/fields/batch/update/results", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "indexes", "fields", "batch", "update", "results" ], "variable": [ { "id": "c5211eec-84fc-4186-b360-1d4b103d374e", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
Example: `mycoveocloudv2organizationg8tp8wu3`" } ] }, "description": "Updates a batch of existing [fields](https://docs.coveo.com/en/200/glossary/field) in the [index](https://docs.coveo.com/en/204/glossary/index) of the target [Coveo Cloud organization](https://docs.coveo.com/en/185/).

**Required privilege:** Fields - Edit

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"FIELD\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "db5b276b-e02e-494c-a543-d0df6cce347e", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"label\": \"\",\n \"automaticFacetsCandidate\": false,\n \"automaticFacetsCandidateTags\": [\n \"\",\n \"\"\n ],\n \"type\": \"DATE\",\n \"includeInQuery\": true,\n \"includeInResults\": true,\n \"keyValue\": false,\n \"multilingual\": false,\n \"keepAccentsDisplayValueFacet\": false,\n \"keepDistinctDisplayValueFacet\": false,\n \"mergeWithLexicon\": false,\n \"smartDateFacet\": false,\n \"facet\": \"\",\n \"multiValueFacet\": false,\n \"hierarchicalFacet\": false,\n \"sort\": \"\",\n \"ranking\": false,\n \"stemming\": false,\n \"multiValueFacetTokenizers\": \"\",\n \"useCacheForNestedQuery\": false,\n \"useCacheForSort\": false,\n \"useCacheForNumericQuery\": false,\n \"useCacheForComputedFacet\": false,\n \"dateFormat\": \"\",\n \"system\": \"\",\n \"projectIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"label\": \"\",\n \"automaticFacetsCandidate\": false,\n \"automaticFacetsCandidateTags\": [\n \"\",\n \"\"\n ],\n \"type\": \"DATE\",\n \"includeInQuery\": true,\n \"includeInResults\": true,\n \"keyValue\": false,\n \"multilingual\": false,\n \"keepAccentsDisplayValueFacet\": false,\n \"keepDistinctDisplayValueFacet\": false,\n \"mergeWithLexicon\": false,\n \"smartDateFacet\": false,\n \"facet\": \"\",\n \"multiValueFacet\": false,\n \"hierarchicalFacet\": false,\n \"sort\": \"\",\n \"ranking\": false,\n \"stemming\": false,\n \"multiValueFacetTokenizers\": \"\",\n \"useCacheForNestedQuery\": false,\n \"useCacheForSort\": false,\n \"useCacheForNumericQuery\": false,\n \"useCacheForComputedFacet\": false,\n \"dateFormat\": \"\",\n \"system\": \"\",\n \"projectIds\": [\n \"\",\n \"\"\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/indexes/fields/batch/update/results", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "indexes", "fields", "batch", "update", "results" ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"batchOperationId\": \"\",\n \"status\": \"COMPLETED\",\n \"batchOperationResourcesStatus\": [\n {\n \"resourceModel\": {\n \"name\": \"\",\n \"description\": \"\",\n \"label\": \"\",\n \"automaticFacetsCandidate\": false,\n \"automaticFacetsCandidateTags\": [\n \"\",\n \"\"\n ],\n \"type\": \"DATE\",\n \"includeInQuery\": true,\n \"includeInResults\": true,\n \"keyValue\": false,\n \"multilingual\": false,\n \"keepAccentsDisplayValueFacet\": false,\n \"keepDistinctDisplayValueFacet\": false,\n \"mergeWithLexicon\": false,\n \"smartDateFacet\": false,\n \"facet\": \"\",\n \"multiValueFacet\": false,\n \"hierarchicalFacet\": false,\n \"sort\": \"\",\n \"ranking\": false,\n \"stemming\": false,\n \"multiValueFacetTokenizers\": \"\",\n \"useCacheForNestedQuery\": false,\n \"useCacheForSort\": false,\n \"useCacheForNumericQuery\": false,\n \"useCacheForComputedFacet\": false,\n \"dateFormat\": \"\",\n \"system\": \"\",\n \"projectIds\": [\n \"\",\n \"\"\n ]\n },\n \"operationResult\": \"ERROR\",\n \"errorDetails\": \"\",\n \"successful\": \"\"\n },\n {\n \"resourceModel\": {\n \"name\": \"\",\n \"description\": \"\",\n \"label\": \"\",\n \"automaticFacetsCandidate\": false,\n \"automaticFacetsCandidateTags\": [\n \"\",\n \"\"\n ],\n \"type\": \"VECTOR\",\n \"includeInQuery\": true,\n \"includeInResults\": true,\n \"keyValue\": false,\n \"multilingual\": false,\n \"keepAccentsDisplayValueFacet\": false,\n \"keepDistinctDisplayValueFacet\": false,\n \"mergeWithLexicon\": false,\n \"smartDateFacet\": false,\n \"facet\": \"\",\n \"multiValueFacet\": false,\n \"hierarchicalFacet\": false,\n \"sort\": \"\",\n \"ranking\": false,\n \"stemming\": false,\n \"multiValueFacetTokenizers\": \"\",\n \"useCacheForNestedQuery\": false,\n \"useCacheForSort\": false,\n \"useCacheForNumericQuery\": false,\n \"useCacheForComputedFacet\": false,\n \"dateFormat\": \"\",\n \"system\": \"\",\n \"projectIds\": [\n \"\",\n \"\"\n ]\n },\n \"operationResult\": \"SUCCESS\",\n \"errorDetails\": \"\",\n \"successful\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:28:32.000Z", "updatedAt": "2026-07-28T01:28:32.000Z", "uid": "35240-db5b276b-e02e-494c-a543-d0df6cce347e" } ], "createdAt": "2026-07-28T01:28:32.000Z", "updatedAt": "2026-07-28T01:28:32.000Z", "uid": "35240-96eff9c9-4611-46ec-86bd-3c9036871f4a" } ], "id": "ee6ecc0c-dc39-434c-9350-40708eb315d9", "createdAt": "2026-07-28T01:28:32.000Z", "updatedAt": "2026-07-28T01:28:32.000Z", "uid": "35240-ee6ecc0c-dc39-434c-9350-40708eb315d9" }, { "name": "Update Fields", "id": "2dfa1a80-7408-4c6a-89fa-466bf3950fee", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"label\": \"\",\n \"automaticFacetsCandidate\": false,\n \"automaticFacetsCandidateTags\": [\n \"\",\n \"\"\n ],\n \"type\": \"DATE\",\n \"includeInQuery\": true,\n \"includeInResults\": true,\n \"keyValue\": false,\n \"multilingual\": false,\n \"keepAccentsDisplayValueFacet\": false,\n \"keepDistinctDisplayValueFacet\": false,\n \"mergeWithLexicon\": false,\n \"smartDateFacet\": false,\n \"facet\": \"\",\n \"multiValueFacet\": false,\n \"hierarchicalFacet\": false,\n \"sort\": \"\",\n \"ranking\": false,\n \"stemming\": false,\n \"multiValueFacetTokenizers\": \"\",\n \"useCacheForNestedQuery\": false,\n \"useCacheForSort\": false,\n \"useCacheForNumericQuery\": false,\n \"useCacheForComputedFacet\": false,\n \"dateFormat\": \"\",\n \"system\": \"\",\n \"projectIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"label\": \"\",\n \"automaticFacetsCandidate\": false,\n \"automaticFacetsCandidateTags\": [\n \"\",\n \"\"\n ],\n \"type\": \"DATE\",\n \"includeInQuery\": true,\n \"includeInResults\": true,\n \"keyValue\": false,\n \"multilingual\": false,\n \"keepAccentsDisplayValueFacet\": false,\n \"keepDistinctDisplayValueFacet\": false,\n \"mergeWithLexicon\": false,\n \"smartDateFacet\": false,\n \"facet\": \"\",\n \"multiValueFacet\": false,\n \"hierarchicalFacet\": false,\n \"sort\": \"\",\n \"ranking\": false,\n \"stemming\": false,\n \"multiValueFacetTokenizers\": \"\",\n \"useCacheForNestedQuery\": false,\n \"useCacheForSort\": false,\n \"useCacheForNumericQuery\": false,\n \"useCacheForComputedFacet\": false,\n \"dateFormat\": \"\",\n \"system\": \"\",\n \"projectIds\": [\n \"\",\n \"\"\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/indexes/fields/batch/update", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "indexes", "fields", "batch", "update" ], "variable": [ { "id": "6269019d-9928-4379-8e72-374969501939", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
Example: `mycoveocloudv2organizationg8tp8wu3`" } ] }, "description": "Updates a batch of existing [fields](https://docs.coveo.com/en/200/glossary/field) in the [index](https://docs.coveo.com/en/204/glossary/index) of the target [Coveo Cloud organization](https://docs.coveo.com/en/185/).

**Required privilege:** Fields - Edit

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"FIELD\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "c26eae5c-3ade-4a35-901e-0aaef4713226", "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 {\n \"name\": \"\",\n \"description\": \"\",\n \"label\": \"\",\n \"automaticFacetsCandidate\": false,\n \"automaticFacetsCandidateTags\": [\n \"\",\n \"\"\n ],\n \"type\": \"DATE\",\n \"includeInQuery\": true,\n \"includeInResults\": true,\n \"keyValue\": false,\n \"multilingual\": false,\n \"keepAccentsDisplayValueFacet\": false,\n \"keepDistinctDisplayValueFacet\": false,\n \"mergeWithLexicon\": false,\n \"smartDateFacet\": false,\n \"facet\": \"\",\n \"multiValueFacet\": false,\n \"hierarchicalFacet\": false,\n \"sort\": \"\",\n \"ranking\": false,\n \"stemming\": false,\n \"multiValueFacetTokenizers\": \"\",\n \"useCacheForNestedQuery\": false,\n \"useCacheForSort\": false,\n \"useCacheForNumericQuery\": false,\n \"useCacheForComputedFacet\": false,\n \"dateFormat\": \"\",\n \"system\": \"\",\n \"projectIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"label\": \"\",\n \"automaticFacetsCandidate\": false,\n \"automaticFacetsCandidateTags\": [\n \"\",\n \"\"\n ],\n \"type\": \"DATE\",\n \"includeInQuery\": true,\n \"includeInResults\": true,\n \"keyValue\": false,\n \"multilingual\": false,\n \"keepAccentsDisplayValueFacet\": false,\n \"keepDistinctDisplayValueFacet\": false,\n \"mergeWithLexicon\": false,\n \"smartDateFacet\": false,\n \"facet\": \"\",\n \"multiValueFacet\": false,\n \"hierarchicalFacet\": false,\n \"sort\": \"\",\n \"ranking\": false,\n \"stemming\": false,\n \"multiValueFacetTokenizers\": \"\",\n \"useCacheForNestedQuery\": false,\n \"useCacheForSort\": false,\n \"useCacheForNumericQuery\": false,\n \"useCacheForComputedFacet\": false,\n \"dateFormat\": \"\",\n \"system\": \"\",\n \"projectIds\": [\n \"\",\n \"\"\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/indexes/fields/batch/update", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "indexes", "fields", "batch", "update" ], "variable": [ { "key": "organizationId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:28:32.000Z", "updatedAt": "2026-07-28T01:28:32.000Z", "uid": "35240-c26eae5c-3ade-4a35-901e-0aaef4713226" } ], "createdAt": "2026-07-28T01:28:32.000Z", "updatedAt": "2026-07-28T01:28:32.000Z", "uid": "35240-2dfa1a80-7408-4c6a-89fa-466bf3950fee" } ], "id": "e62564e7-6a53-4a36-9e37-097217ee5274", "createdAt": "2026-07-28T01:28:32.000Z", "updatedAt": "2026-07-28T01:28:32.000Z", "uid": "35240-e62564e7-6a53-4a36-9e37-097217ee5274" }, { "name": "create", "item": [ { "name": "results", "item": [ { "name": "Create Fields with Individual Results", "id": "35a9f34d-a983-4a7f-80f6-20c38169a716", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "body": { "mode": "raw", "raw": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"label\": \"\",\n \"automaticFacetsCandidate\": false,\n \"automaticFacetsCandidateTags\": [\n \"\",\n \"\"\n ],\n \"type\": \"DATE\",\n \"includeInQuery\": true,\n \"includeInResults\": true,\n \"keyValue\": false,\n \"multilingual\": false,\n \"keepAccentsDisplayValueFacet\": false,\n \"keepDistinctDisplayValueFacet\": false,\n \"mergeWithLexicon\": false,\n \"smartDateFacet\": false,\n \"facet\": \"\",\n \"multiValueFacet\": false,\n \"hierarchicalFacet\": false,\n \"sort\": \"\",\n \"ranking\": false,\n \"stemming\": false,\n \"multiValueFacetTokenizers\": \"\",\n \"useCacheForNestedQuery\": false,\n \"useCacheForSort\": false,\n \"useCacheForNumericQuery\": false,\n \"useCacheForComputedFacet\": false,\n \"dateFormat\": \"\",\n \"system\": \"\",\n \"projectIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"label\": \"\",\n \"automaticFacetsCandidate\": false,\n \"automaticFacetsCandidateTags\": [\n \"\",\n \"\"\n ],\n \"type\": \"DOUBLE\",\n \"includeInQuery\": true,\n \"includeInResults\": true,\n \"keyValue\": false,\n \"multilingual\": false,\n \"keepAccentsDisplayValueFacet\": false,\n \"keepDistinctDisplayValueFacet\": false,\n \"mergeWithLexicon\": false,\n \"smartDateFacet\": false,\n \"facet\": \"\",\n \"multiValueFacet\": false,\n \"hierarchicalFacet\": false,\n \"sort\": \"\",\n \"ranking\": false,\n \"stemming\": false,\n \"multiValueFacetTokenizers\": \"\",\n \"useCacheForNestedQuery\": false,\n \"useCacheForSort\": false,\n \"useCacheForNumericQuery\": false,\n \"useCacheForComputedFacet\": false,\n \"dateFormat\": \"\",\n \"system\": \"\",\n \"projectIds\": [\n \"\",\n \"\"\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/indexes/fields/batch/create/results", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "indexes", "fields", "batch", "create", "results" ], "variable": [ { "id": "2236a395-a31b-4a3d-9323-29df166b9578", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
Example: `mycoveocloudv2organizationg8tp8wu3`" } ] }, "description": "Creates a batch of [fields](https://docs.coveo.com/en/200/glossary/field) in the [index](https://docs.coveo.com/en/204/glossary/index) of the target [Coveo Cloud organization](https://docs.coveo.com/en/185/).

**Required privilege:** Fields - Create

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"FIELD\",\"type\":\"CREATE\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "2feabd72-ba22-40b7-8dba-9a4dca1d7bc1", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"label\": \"\",\n \"automaticFacetsCandidate\": false,\n \"automaticFacetsCandidateTags\": [\n \"\",\n \"\"\n ],\n \"type\": \"DATE\",\n \"includeInQuery\": true,\n \"includeInResults\": true,\n \"keyValue\": false,\n \"multilingual\": false,\n \"keepAccentsDisplayValueFacet\": false,\n \"keepDistinctDisplayValueFacet\": false,\n \"mergeWithLexicon\": false,\n \"smartDateFacet\": false,\n \"facet\": \"\",\n \"multiValueFacet\": false,\n \"hierarchicalFacet\": false,\n \"sort\": \"\",\n \"ranking\": false,\n \"stemming\": false,\n \"multiValueFacetTokenizers\": \"\",\n \"useCacheForNestedQuery\": false,\n \"useCacheForSort\": false,\n \"useCacheForNumericQuery\": false,\n \"useCacheForComputedFacet\": false,\n \"dateFormat\": \"\",\n \"system\": \"\",\n \"projectIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"label\": \"\",\n \"automaticFacetsCandidate\": false,\n \"automaticFacetsCandidateTags\": [\n \"\",\n \"\"\n ],\n \"type\": \"DOUBLE\",\n \"includeInQuery\": true,\n \"includeInResults\": true,\n \"keyValue\": false,\n \"multilingual\": false,\n \"keepAccentsDisplayValueFacet\": false,\n \"keepDistinctDisplayValueFacet\": false,\n \"mergeWithLexicon\": false,\n \"smartDateFacet\": false,\n \"facet\": \"\",\n \"multiValueFacet\": false,\n \"hierarchicalFacet\": false,\n \"sort\": \"\",\n \"ranking\": false,\n \"stemming\": false,\n \"multiValueFacetTokenizers\": \"\",\n \"useCacheForNestedQuery\": false,\n \"useCacheForSort\": false,\n \"useCacheForNumericQuery\": false,\n \"useCacheForComputedFacet\": false,\n \"dateFormat\": \"\",\n \"system\": \"\",\n \"projectIds\": [\n \"\",\n \"\"\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/indexes/fields/batch/create/results", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "indexes", "fields", "batch", "create", "results" ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"batchOperationId\": \"\",\n \"status\": \"COMPLETED\",\n \"batchOperationResourcesStatus\": [\n {\n \"resourceModel\": {\n \"name\": \"\",\n \"description\": \"\",\n \"label\": \"\",\n \"automaticFacetsCandidate\": false,\n \"automaticFacetsCandidateTags\": [\n \"\",\n \"\"\n ],\n \"type\": \"DATE\",\n \"includeInQuery\": true,\n \"includeInResults\": true,\n \"keyValue\": false,\n \"multilingual\": false,\n \"keepAccentsDisplayValueFacet\": false,\n \"keepDistinctDisplayValueFacet\": false,\n \"mergeWithLexicon\": false,\n \"smartDateFacet\": false,\n \"facet\": \"\",\n \"multiValueFacet\": false,\n \"hierarchicalFacet\": false,\n \"sort\": \"\",\n \"ranking\": false,\n \"stemming\": false,\n \"multiValueFacetTokenizers\": \"\",\n \"useCacheForNestedQuery\": false,\n \"useCacheForSort\": false,\n \"useCacheForNumericQuery\": false,\n \"useCacheForComputedFacet\": false,\n \"dateFormat\": \"\",\n \"system\": \"\",\n \"projectIds\": [\n \"\",\n \"\"\n ]\n },\n \"operationResult\": \"ERROR\",\n \"errorDetails\": \"\",\n \"successful\": \"\"\n },\n {\n \"resourceModel\": {\n \"name\": \"\",\n \"description\": \"\",\n \"label\": \"\",\n \"automaticFacetsCandidate\": false,\n \"automaticFacetsCandidateTags\": [\n \"\",\n \"\"\n ],\n \"type\": \"VECTOR\",\n \"includeInQuery\": true,\n \"includeInResults\": true,\n \"keyValue\": false,\n \"multilingual\": false,\n \"keepAccentsDisplayValueFacet\": false,\n \"keepDistinctDisplayValueFacet\": false,\n \"mergeWithLexicon\": false,\n \"smartDateFacet\": false,\n \"facet\": \"\",\n \"multiValueFacet\": false,\n \"hierarchicalFacet\": false,\n \"sort\": \"\",\n \"ranking\": false,\n \"stemming\": false,\n \"multiValueFacetTokenizers\": \"\",\n \"useCacheForNestedQuery\": false,\n \"useCacheForSort\": false,\n \"useCacheForNumericQuery\": false,\n \"useCacheForComputedFacet\": false,\n \"dateFormat\": \"\",\n \"system\": \"\",\n \"projectIds\": [\n \"\",\n \"\"\n ]\n },\n \"operationResult\": \"SUCCESS\",\n \"errorDetails\": \"\",\n \"successful\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:28:32.000Z", "updatedAt": "2026-07-28T01:28:32.000Z", "uid": "35240-2feabd72-ba22-40b7-8dba-9a4dca1d7bc1" } ], "createdAt": "2026-07-28T01:28:32.000Z", "updatedAt": "2026-07-28T01:28:32.000Z", "uid": "35240-35a9f34d-a983-4a7f-80f6-20c38169a716" } ], "id": "04d4ffae-a8ba-4bc3-8148-8c782bf15691", "createdAt": "2026-07-28T01:28:32.000Z", "updatedAt": "2026-07-28T01:28:32.000Z", "uid": "35240-04d4ffae-a8ba-4bc3-8148-8c782bf15691" }, { "name": "Create Fields", "id": "d1049667-7bbf-4513-bb3c-6e75f1d9a3dd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"label\": \"\",\n \"automaticFacetsCandidate\": false,\n \"automaticFacetsCandidateTags\": [\n \"\",\n \"\"\n ],\n \"type\": \"DATE\",\n \"includeInQuery\": true,\n \"includeInResults\": true,\n \"keyValue\": false,\n \"multilingual\": false,\n \"keepAccentsDisplayValueFacet\": false,\n \"keepDistinctDisplayValueFacet\": false,\n \"mergeWithLexicon\": false,\n \"smartDateFacet\": false,\n \"facet\": \"\",\n \"multiValueFacet\": false,\n \"hierarchicalFacet\": false,\n \"sort\": \"\",\n \"ranking\": false,\n \"stemming\": false,\n \"multiValueFacetTokenizers\": \"\",\n \"useCacheForNestedQuery\": false,\n \"useCacheForSort\": false,\n \"useCacheForNumericQuery\": false,\n \"useCacheForComputedFacet\": false,\n \"dateFormat\": \"\",\n \"system\": \"\",\n \"projectIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"label\": \"\",\n \"automaticFacetsCandidate\": false,\n \"automaticFacetsCandidateTags\": [\n \"\",\n \"\"\n ],\n \"type\": \"DOUBLE\",\n \"includeInQuery\": true,\n \"includeInResults\": true,\n \"keyValue\": false,\n \"multilingual\": false,\n \"keepAccentsDisplayValueFacet\": false,\n \"keepDistinctDisplayValueFacet\": false,\n \"mergeWithLexicon\": false,\n \"smartDateFacet\": false,\n \"facet\": \"\",\n \"multiValueFacet\": false,\n \"hierarchicalFacet\": false,\n \"sort\": \"\",\n \"ranking\": false,\n \"stemming\": false,\n \"multiValueFacetTokenizers\": \"\",\n \"useCacheForNestedQuery\": false,\n \"useCacheForSort\": false,\n \"useCacheForNumericQuery\": false,\n \"useCacheForComputedFacet\": false,\n \"dateFormat\": \"\",\n \"system\": \"\",\n \"projectIds\": [\n \"\",\n \"\"\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/indexes/fields/batch/create", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "indexes", "fields", "batch", "create" ], "variable": [ { "id": "a88b950d-818e-46e8-ab48-a4c965b202df", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
Example: `mycoveocloudv2organizationg8tp8wu3`" } ] }, "description": "Creates a batch of [fields](https://docs.coveo.com/en/200/glossary/field) in the [index](https://docs.coveo.com/en/204/glossary/index) of the target [Coveo Cloud organization](https://docs.coveo.com/en/185/).

**Required privilege:** Fields - Create

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"FIELD\",\"type\":\"CREATE\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "7be1e64d-951a-4b15-9e29-62b9818a3331", "name": "No Content", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "[\n {\n \"name\": \"\",\n \"description\": \"\",\n \"label\": \"\",\n \"automaticFacetsCandidate\": false,\n \"automaticFacetsCandidateTags\": [\n \"\",\n \"\"\n ],\n \"type\": \"DATE\",\n \"includeInQuery\": true,\n \"includeInResults\": true,\n \"keyValue\": false,\n \"multilingual\": false,\n \"keepAccentsDisplayValueFacet\": false,\n \"keepDistinctDisplayValueFacet\": false,\n \"mergeWithLexicon\": false,\n \"smartDateFacet\": false,\n \"facet\": \"\",\n \"multiValueFacet\": false,\n \"hierarchicalFacet\": false,\n \"sort\": \"\",\n \"ranking\": false,\n \"stemming\": false,\n \"multiValueFacetTokenizers\": \"\",\n \"useCacheForNestedQuery\": false,\n \"useCacheForSort\": false,\n \"useCacheForNumericQuery\": false,\n \"useCacheForComputedFacet\": false,\n \"dateFormat\": \"\",\n \"system\": \"\",\n \"projectIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"label\": \"\",\n \"automaticFacetsCandidate\": false,\n \"automaticFacetsCandidateTags\": [\n \"\",\n \"\"\n ],\n \"type\": \"DOUBLE\",\n \"includeInQuery\": true,\n \"includeInResults\": true,\n \"keyValue\": false,\n \"multilingual\": false,\n \"keepAccentsDisplayValueFacet\": false,\n \"keepDistinctDisplayValueFacet\": false,\n \"mergeWithLexicon\": false,\n \"smartDateFacet\": false,\n \"facet\": \"\",\n \"multiValueFacet\": false,\n \"hierarchicalFacet\": false,\n \"sort\": \"\",\n \"ranking\": false,\n \"stemming\": false,\n \"multiValueFacetTokenizers\": \"\",\n \"useCacheForNestedQuery\": false,\n \"useCacheForSort\": false,\n \"useCacheForNumericQuery\": false,\n \"useCacheForComputedFacet\": false,\n \"dateFormat\": \"\",\n \"system\": \"\",\n \"projectIds\": [\n \"\",\n \"\"\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/indexes/fields/batch/create", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "indexes", "fields", "batch", "create" ], "variable": [ { "key": "organizationId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:28:32.000Z", "updatedAt": "2026-07-28T01:28:32.000Z", "uid": "35240-7be1e64d-951a-4b15-9e29-62b9818a3331" } ], "createdAt": "2026-07-28T01:28:32.000Z", "updatedAt": "2026-07-28T01:28:32.000Z", "uid": "35240-d1049667-7bbf-4513-bb3c-6e75f1d9a3dd" } ], "id": "038874b6-9380-480c-9531-32cf29dffbdc", "createdAt": "2026-07-28T01:28:32.000Z", "updatedAt": "2026-07-28T01:28:32.000Z", "uid": "35240-038874b6-9380-480c-9531-32cf29dffbdc" }, { "name": "delete", "item": [ { "name": "results", "item": [ { "name": "Delete Fields with Individual Results", "id": "f7b9300f-d443-468c-bad2-9f46bcf9c50d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/indexes/fields/batch/delete/results?fields=&fields=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "indexes", "fields", "batch", "delete", "results" ], "query": [ { "description": "(Required) The `name` properties of the fields to delete.
**Example:** `myfield1,myfield2,myfield3`", "key": "fields", "value": "" }, { "description": "(Required) The `name` properties of the fields to delete.
**Example:** `myfield1,myfield2,myfield3`", "key": "fields", "value": "" } ], "variable": [ { "id": "6490c91f-9c7f-4d01-b9fb-398f9b442e5e", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
Example: `mycoveocloudv2organizationg8tp8wu3`" } ] }, "description": "Deletes a batch of [fields](https://docs.coveo.com/en/200/glossary/field) in the [index](https://docs.coveo.com/en/204/glossary/index) of the target [Coveo Cloud organization](https://docs.coveo.com/en/185/).

**Required privilege:** Fields - Edit

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"FIELD\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "2b9c850e-0397-44ae-9286-24069096d5c0", "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/indexes/fields/batch/delete/results?fields=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "indexes", "fields", "batch", "delete", "results" ], "query": [ { "description": "(Required) The `name` properties of the fields to delete.
**Example:** `myfield1,myfield2,myfield3`", "key": "fields", "value": "" } ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"batchOperationId\": \"\",\n \"status\": \"COMPLETED\",\n \"batchOperationResourcesStatus\": [\n {\n \"resourceModel\": {\n \"name\": \"\",\n \"description\": \"\",\n \"label\": \"\",\n \"automaticFacetsCandidate\": false,\n \"automaticFacetsCandidateTags\": [\n \"\",\n \"\"\n ],\n \"type\": \"DATE\",\n \"includeInQuery\": true,\n \"includeInResults\": true,\n \"keyValue\": false,\n \"multilingual\": false,\n \"keepAccentsDisplayValueFacet\": false,\n \"keepDistinctDisplayValueFacet\": false,\n \"mergeWithLexicon\": false,\n \"smartDateFacet\": false,\n \"facet\": \"\",\n \"multiValueFacet\": false,\n \"hierarchicalFacet\": false,\n \"sort\": \"\",\n \"ranking\": false,\n \"stemming\": false,\n \"multiValueFacetTokenizers\": \"\",\n \"useCacheForNestedQuery\": false,\n \"useCacheForSort\": false,\n \"useCacheForNumericQuery\": false,\n \"useCacheForComputedFacet\": false,\n \"dateFormat\": \"\",\n \"system\": \"\",\n \"projectIds\": [\n \"\",\n \"\"\n ]\n },\n \"operationResult\": \"ERROR\",\n \"errorDetails\": \"\",\n \"successful\": \"\"\n },\n {\n \"resourceModel\": {\n \"name\": \"\",\n \"description\": \"\",\n \"label\": \"\",\n \"automaticFacetsCandidate\": false,\n \"automaticFacetsCandidateTags\": [\n \"\",\n \"\"\n ],\n \"type\": \"VECTOR\",\n \"includeInQuery\": true,\n \"includeInResults\": true,\n \"keyValue\": false,\n \"multilingual\": false,\n \"keepAccentsDisplayValueFacet\": false,\n \"keepDistinctDisplayValueFacet\": false,\n \"mergeWithLexicon\": false,\n \"smartDateFacet\": false,\n \"facet\": \"\",\n \"multiValueFacet\": false,\n \"hierarchicalFacet\": false,\n \"sort\": \"\",\n \"ranking\": false,\n \"stemming\": false,\n \"multiValueFacetTokenizers\": \"\",\n \"useCacheForNestedQuery\": false,\n \"useCacheForSort\": false,\n \"useCacheForNumericQuery\": false,\n \"useCacheForComputedFacet\": false,\n \"dateFormat\": \"\",\n \"system\": \"\",\n \"projectIds\": [\n \"\",\n \"\"\n ]\n },\n \"operationResult\": \"SUCCESS\",\n \"errorDetails\": \"\",\n \"successful\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:28:32.000Z", "updatedAt": "2026-07-28T01:28:32.000Z", "uid": "35240-2b9c850e-0397-44ae-9286-24069096d5c0" } ], "createdAt": "2026-07-28T01:28:32.000Z", "updatedAt": "2026-07-28T01:28:32.000Z", "uid": "35240-f7b9300f-d443-468c-bad2-9f46bcf9c50d" } ], "id": "c3730dfd-a671-4a5c-8676-99decde42b30", "createdAt": "2026-07-28T01:28:32.000Z", "updatedAt": "2026-07-28T01:28:32.000Z", "uid": "35240-c3730dfd-a671-4a5c-8676-99decde42b30" }, { "name": "Delete Fields", "id": "dd5333db-7142-4183-953a-c7e3469c10db", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/indexes/fields/batch/delete?fields=&fields=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "indexes", "fields", "batch", "delete" ], "query": [ { "description": "(Required) The `name` properties of the fields to delete.
**Example:** `myfield1,myfield2,myfield3`", "key": "fields", "value": "" }, { "description": "(Required) The `name` properties of the fields to delete.
**Example:** `myfield1,myfield2,myfield3`", "key": "fields", "value": "" } ], "variable": [ { "id": "a03ec32a-d80f-4c2b-9a73-247ceb3b8c97", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
Example: `mycoveocloudv2organizationg8tp8wu3`" } ] }, "description": "Deletes a batch of [fields](https://docs.coveo.com/en/200/glossary/field) in the [index](https://docs.coveo.com/en/204/glossary/index) of the target [Coveo Cloud organization](https://docs.coveo.com/en/185/).

**Required privilege:** Fields - Edit

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"FIELD\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "411e0196-efee-4e1a-a51b-5a996f52aae3", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/indexes/fields/batch/delete?fields=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "indexes", "fields", "batch", "delete" ], "query": [ { "description": "(Required) The `name` properties of the fields to delete.
**Example:** `myfield1,myfield2,myfield3`", "key": "fields", "value": "" } ], "variable": [ { "key": "organizationId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:28:32.000Z", "updatedAt": "2026-07-28T01:28:32.000Z", "uid": "35240-411e0196-efee-4e1a-a51b-5a996f52aae3" } ], "createdAt": "2026-07-28T01:28:32.000Z", "updatedAt": "2026-07-28T01:28:32.000Z", "uid": "35240-dd5333db-7142-4183-953a-c7e3469c10db" } ], "id": "6687241b-460c-4c1b-8679-f471a86b02b2", "createdAt": "2026-07-28T01:28:32.000Z", "updatedAt": "2026-07-28T01:28:32.000Z", "uid": "35240-6687241b-460c-4c1b-8679-f471a86b02b2" } ], "id": "23f74119-9f47-4753-9da3-ac6fa84b66ad", "createdAt": "2026-07-28T01:28:32.000Z", "updatedAt": "2026-07-28T01:28:32.000Z", "uid": "35240-23f74119-9f47-4753-9da3-ac6fa84b66ad" }, { "name": "search", "item": [ { "name": "List Fields", "id": "45c90c75-b436-4e97-a1db-372e745a6a03", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "body": { "mode": "raw", "raw": "{\n \"page\": 0,\n \"perPage\": 100,\n \"sortBy\": \"name\",\n \"order\": \"ASC\",\n \"filters\": {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"origin\": \"ALL\",\n \"facet\": \"ALL\",\n \"automaticFacetsCandidate\": \"ALL\",\n \"sort\": \"ALL\",\n \"projectId\": \"\",\n \"fieldNames\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/indexes/fields/search", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "indexes", "fields", "search" ], "variable": [ { "id": "ee6752f3-e72e-4bf7-9b18-e041106ed184", "key": "organizationId", "value": "", "description": "(Required) " } ] }, "description": "Retrieves a filtered and paginated list of [fields](https://docs.coveo.com/en/200/) from the [index](https://docs.coveo.com/en/204/) of the target Coveo Cloud [organization](https://docs.coveo.com/en/185/).

**Required privilege:** Fields - View

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"FIELD\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "7a741f72-1858-45c1-83f1-f8f29b3e34f6", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"page\": 0,\n \"perPage\": 100,\n \"sortBy\": \"name\",\n \"order\": \"ASC\",\n \"filters\": {\n \"name\": \"\",\n \"type\": \"STRING\",\n \"origin\": \"ALL\",\n \"facet\": \"ALL\",\n \"automaticFacetsCandidate\": \"ALL\",\n \"sort\": \"ALL\",\n \"projectId\": \"\",\n \"fieldNames\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/indexes/fields/search", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "indexes", "fields", "search" ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"items\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"label\": \"\",\n \"automaticFacetsCandidate\": false,\n \"automaticFacetsCandidateTags\": [\n \"\",\n \"\"\n ],\n \"type\": \"LONG_64\",\n \"includeInQuery\": true,\n \"includeInResults\": true,\n \"keyValue\": false,\n \"multilingual\": false,\n \"keepAccentsDisplayValueFacet\": false,\n \"keepDistinctDisplayValueFacet\": false,\n \"mergeWithLexicon\": false,\n \"smartDateFacet\": false,\n \"facet\": \"\",\n \"multiValueFacet\": false,\n \"hierarchicalFacet\": false,\n \"sort\": \"\",\n \"ranking\": false,\n \"stemming\": false,\n \"multiValueFacetTokenizers\": \"\",\n \"useCacheForNestedQuery\": false,\n \"useCacheForSort\": false,\n \"useCacheForNumericQuery\": false,\n \"useCacheForComputedFacet\": false,\n \"dateFormat\": \"\",\n \"system\": \"\",\n \"projectIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"label\": \"\",\n \"automaticFacetsCandidate\": false,\n \"automaticFacetsCandidateTags\": [\n \"\",\n \"\"\n ],\n \"type\": \"LONG_64\",\n \"includeInQuery\": true,\n \"includeInResults\": true,\n \"keyValue\": false,\n \"multilingual\": false,\n \"keepAccentsDisplayValueFacet\": false,\n \"keepDistinctDisplayValueFacet\": false,\n \"mergeWithLexicon\": false,\n \"smartDateFacet\": false,\n \"facet\": \"\",\n \"multiValueFacet\": false,\n \"hierarchicalFacet\": false,\n \"sort\": \"\",\n \"ranking\": false,\n \"stemming\": false,\n \"multiValueFacetTokenizers\": \"\",\n \"useCacheForNestedQuery\": false,\n \"useCacheForSort\": false,\n \"useCacheForNumericQuery\": false,\n \"useCacheForComputedFacet\": false,\n \"dateFormat\": \"\",\n \"system\": \"\",\n \"projectIds\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"totalEntries\": \"\",\n \"totalPages\": \"\"\n}", "createdAt": "2026-07-28T01:28:32.000Z", "updatedAt": "2026-07-28T01:28:32.000Z", "uid": "35240-7a741f72-1858-45c1-83f1-f8f29b3e34f6" } ], "createdAt": "2026-07-28T01:28:32.000Z", "updatedAt": "2026-07-28T01:28:32.000Z", "uid": "35240-45c90c75-b436-4e97-a1db-372e745a6a03" } ], "id": "6d4f2e30-d9a4-4734-ade1-486ebb924986", "createdAt": "2026-07-28T01:28:32.000Z", "updatedAt": "2026-07-28T01:28:32.000Z", "uid": "35240-6d4f2e30-d9a4-4734-ade1-486ebb924986" }, { "name": "Create Field", "id": "3b790829-7e6c-4f31-9da5-eb32ddff34fe", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"label\": \"\",\n \"automaticFacetsCandidate\": false,\n \"automaticFacetsCandidateTags\": [\n \"\",\n \"\"\n ],\n \"type\": \"VECTOR\",\n \"includeInQuery\": true,\n \"includeInResults\": true,\n \"keyValue\": false,\n \"multilingual\": false,\n \"keepAccentsDisplayValueFacet\": false,\n \"keepDistinctDisplayValueFacet\": false,\n \"mergeWithLexicon\": false,\n \"smartDateFacet\": false,\n \"facet\": \"\",\n \"multiValueFacet\": false,\n \"hierarchicalFacet\": false,\n \"sort\": \"\",\n \"ranking\": false,\n \"stemming\": false,\n \"multiValueFacetTokenizers\": \"\",\n \"useCacheForNestedQuery\": false,\n \"useCacheForSort\": false,\n \"useCacheForNumericQuery\": false,\n \"useCacheForComputedFacet\": false,\n \"dateFormat\": \"\",\n \"system\": \"\",\n \"projectIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/indexes/fields", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "indexes", "fields" ], "variable": [ { "id": "d712f666-a51a-4330-971a-6cf110916054", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
Example: `mycoveocloudv2organizationg8tp8wu3`" } ] }, "description": "Creates a new [field](https://docs.coveo.com/en/200/glossary/field) in the [index](https://docs.coveo.com/en/204/glossary/index) of the target [Coveo Cloud organization](https://docs.coveo.com/en/185/glossary/coveo-cloud-v2-organization).

**Required privilege:** Fields - Create

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"FIELD\",\"type\":\"CREATE\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "16f16d37-1dfe-43fa-ad23-2402c6e01b39", "name": "No Content", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"label\": \"\",\n \"automaticFacetsCandidate\": false,\n \"automaticFacetsCandidateTags\": [\n \"\",\n \"\"\n ],\n \"type\": \"VECTOR\",\n \"includeInQuery\": true,\n \"includeInResults\": true,\n \"keyValue\": false,\n \"multilingual\": false,\n \"keepAccentsDisplayValueFacet\": false,\n \"keepDistinctDisplayValueFacet\": false,\n \"mergeWithLexicon\": false,\n \"smartDateFacet\": false,\n \"facet\": \"\",\n \"multiValueFacet\": false,\n \"hierarchicalFacet\": false,\n \"sort\": \"\",\n \"ranking\": false,\n \"stemming\": false,\n \"multiValueFacetTokenizers\": \"\",\n \"useCacheForNestedQuery\": false,\n \"useCacheForSort\": false,\n \"useCacheForNumericQuery\": false,\n \"useCacheForComputedFacet\": false,\n \"dateFormat\": \"\",\n \"system\": \"\",\n \"projectIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/indexes/fields", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "indexes", "fields" ], "variable": [ { "key": "organizationId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:28:32.000Z", "updatedAt": "2026-07-28T01:28:32.000Z", "uid": "35240-16f16d37-1dfe-43fa-ad23-2402c6e01b39" } ], "createdAt": "2026-07-28T01:28:32.000Z", "updatedAt": "2026-07-28T01:28:32.000Z", "uid": "35240-3b790829-7e6c-4f31-9da5-eb32ddff34fe" } ], "id": "312bc194-7216-41c8-a1de-4d4cefe0c1dc", "createdAt": "2026-07-28T01:28:32.000Z", "updatedAt": "2026-07-28T01:28:32.000Z", "uid": "35240-312bc194-7216-41c8-a1de-4d4cefe0c1dc" } ], "id": "14afc9aa-b7eb-4da5-b96b-a162c9fd095e", "createdAt": "2026-07-28T01:28:32.000Z", "updatedAt": "2026-07-28T01:28:32.000Z", "uid": "35240-14afc9aa-b7eb-4da5-b96b-a162c9fd095e" } ], "id": "21372a32-a09a-49b8-8cae-37b98b8b2be6", "createdAt": "2026-07-28T01:28:32.000Z", "updatedAt": "2026-07-28T01:28:32.000Z", "uid": "35240-21372a32-a09a-49b8-8cae-37b98b8b2be6" } ], "id": "5b9ebd22-a6e1-4dc2-90d1-2c11cecbe36f", "createdAt": "2026-07-28T01:28:32.000Z", "updatedAt": "2026-07-28T01:28:32.000Z", "uid": "35240-5b9ebd22-a6e1-4dc2-90d1-2c11cecbe36f" } ], "id": "b0d4c428-b6c0-458a-8c45-f7b7c174345a", "createdAt": "2026-07-28T01:28:32.000Z", "updatedAt": "2026-07-28T01:28:32.000Z", "uid": "35240-b0d4c428-b6c0-458a-8c45-f7b7c174345a" } ], "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" } ] }