{ "info": { "_postman_id": "00c301bd-2351-4b8d-b64c-dc64652ddd57", "name": "Coveo Activity Activities Item 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:29:12.000Z", "updatedAt": "2026-07-28T01:29:12.000Z", "lastUpdatedBy": "35240", "uid": "35240-00c301bd-2351-4b8d-b64c-dc64652ddd57" }, "item": [ { "name": "organizations", "item": [ { "name": "{organizationId}", "item": [ { "name": "sources", "item": [ { "name": "{sourceId}", "item": [ { "name": "documents", "item": [ { "name": "batch", "item": [ { "name": "Add, Update, and/or Delete a Batch of Items", "id": "bd6ab330-3c40-4c63-a25d-15a55d664012", "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": [], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/sources/:sourceId/documents/batch?orderingId=&fileId=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "sources", ":sourceId", "documents", "batch" ], "query": [ { "description": "A value indicating the order of arrival of the Push operation in the Coveo Cloud V2 indexing pipeline. A lower value corresponds to an older operation. \nBy default, the service automatically sets this parameter to the current number of milliseconds since Unix Epoch. \nSpecifying a custom `orderingId` value is typically not recommended unless you know what you are doing and have a good reason to do so (see [About the orderingId parameter](https://docs.coveo.com/en/147/)). \n**Example:** `1506700606240`", "key": "orderingId", "value": "" }, { "description": "(Required) The unique identifier of the Amazon S3 file container into which the JSON definition of the content update was previously uploaded (see [Create a file container](https://docs.coveo.com/en/43/)). \n**Example:** d22778ca-7f42-4e13-9d9a-47d01bce866c", "key": "fileId", "value": "" } ], "variable": [ { "id": "155cd3f3-8289-427c-8be7-f8594012cd31", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target Coveo Cloud V2 organization. \n**Example:** `mycoveocloudv2organizationg8tp8wu3`" }, { "id": "c41745e7-369d-4f9f-b008-10593d6cc6e4", "key": "sourceId", "value": "", "description": "(Required) The unique identifier of the target Push source (see [Creating a Push Source](https://developers.coveo.com/x/34s9Ag)). \n**Example:** `rp5rxzbdz753uhndklv2ztkfgy-mycoveocloudv2organizationg8tp8wu3`" } ] }, "description": "Manages a batch of items in a Push source." }, "response": [ { "id": "8d201881-711d-4c31-9ab6-49cb0c72b877", "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/sources/:sourceId/documents/batch?orderingId=&fileId=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "sources", ":sourceId", "documents", "batch" ], "query": [ { "description": "A value indicating the order of arrival of the Push operation in the Coveo Cloud V2 indexing pipeline. A lower value corresponds to an older operation. \nBy default, the service automatically sets this parameter to the current number of milliseconds since Unix Epoch. \nSpecifying a custom `orderingId` value is typically not recommended unless you know what you are doing and have a good reason to do so (see [About the orderingId parameter](https://docs.coveo.com/en/147/)). \n**Example:** `1506700606240`", "key": "orderingId", "value": "" }, { "description": "(Required) The unique identifier of the Amazon S3 file container into which the JSON definition of the content update was previously uploaded (see [Create a file container](https://docs.coveo.com/en/43/)). \n**Example:** d22778ca-7f42-4e13-9d9a-47d01bce866c", "key": "fileId", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "sourceId" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Headers", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Methods", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Origin", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Content-Security-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-XSS-Protection", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:13.000Z", "updatedAt": "2026-07-28T01:29:13.000Z", "uid": "35240-8d201881-711d-4c31-9ab6-49cb0c72b877" }, { "id": "bf545719-2d31-423e-bb09-2dfb34a09426", "name": "Bad request", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/sources/:sourceId/documents/batch?orderingId=&fileId=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "sources", ":sourceId", "documents", "batch" ], "query": [ { "description": "A value indicating the order of arrival of the Push operation in the Coveo Cloud V2 indexing pipeline. A lower value corresponds to an older operation. \nBy default, the service automatically sets this parameter to the current number of milliseconds since Unix Epoch. \nSpecifying a custom `orderingId` value is typically not recommended unless you know what you are doing and have a good reason to do so (see [About the orderingId parameter](https://docs.coveo.com/en/147/)). \n**Example:** `1506700606240`", "key": "orderingId", "value": "" }, { "description": "(Required) The unique identifier of the Amazon S3 file container into which the JSON definition of the content update was previously uploaded (see [Create a file container](https://docs.coveo.com/en/43/)). \n**Example:** d22778ca-7f42-4e13-9d9a-47d01bce866c", "key": "fileId", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "sourceId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Headers", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Methods", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Origin", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Content-Security-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-XSS-Protection", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:13.000Z", "updatedAt": "2026-07-28T01:29:13.000Z", "uid": "35240-bf545719-2d31-423e-bb09-2dfb34a09426" }, { "id": "b64adb37-a9a2-4274-bf8f-2629bba35a34", "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/sources/:sourceId/documents/batch?orderingId=&fileId=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "sources", ":sourceId", "documents", "batch" ], "query": [ { "description": "A value indicating the order of arrival of the Push operation in the Coveo Cloud V2 indexing pipeline. A lower value corresponds to an older operation. \nBy default, the service automatically sets this parameter to the current number of milliseconds since Unix Epoch. \nSpecifying a custom `orderingId` value is typically not recommended unless you know what you are doing and have a good reason to do so (see [About the orderingId parameter](https://docs.coveo.com/en/147/)). \n**Example:** `1506700606240`", "key": "orderingId", "value": "" }, { "description": "(Required) The unique identifier of the Amazon S3 file container into which the JSON definition of the content update was previously uploaded (see [Create a file container](https://docs.coveo.com/en/43/)). \n**Example:** d22778ca-7f42-4e13-9d9a-47d01bce866c", "key": "fileId", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "sourceId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Headers", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Methods", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Origin", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Content-Security-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-XSS-Protection", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:13.000Z", "updatedAt": "2026-07-28T01:29:13.000Z", "uid": "35240-b64adb37-a9a2-4274-bf8f-2629bba35a34" }, { "id": "bc750dcb-75fa-4ab3-9710-b78713fc4851", "name": "Forbidden", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/sources/:sourceId/documents/batch?orderingId=&fileId=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "sources", ":sourceId", "documents", "batch" ], "query": [ { "description": "A value indicating the order of arrival of the Push operation in the Coveo Cloud V2 indexing pipeline. A lower value corresponds to an older operation. \nBy default, the service automatically sets this parameter to the current number of milliseconds since Unix Epoch. \nSpecifying a custom `orderingId` value is typically not recommended unless you know what you are doing and have a good reason to do so (see [About the orderingId parameter](https://docs.coveo.com/en/147/)). \n**Example:** `1506700606240`", "key": "orderingId", "value": "" }, { "description": "(Required) The unique identifier of the Amazon S3 file container into which the JSON definition of the content update was previously uploaded (see [Create a file container](https://docs.coveo.com/en/43/)). \n**Example:** d22778ca-7f42-4e13-9d9a-47d01bce866c", "key": "fileId", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "sourceId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Headers", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Methods", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Origin", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Content-Security-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-XSS-Protection", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:13.000Z", "updatedAt": "2026-07-28T01:29:13.000Z", "uid": "35240-bc750dcb-75fa-4ab3-9710-b78713fc4851" }, { "id": "d1ed241b-21df-4ad5-81f8-be27e754596e", "name": "Not found", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/sources/:sourceId/documents/batch?orderingId=&fileId=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "sources", ":sourceId", "documents", "batch" ], "query": [ { "description": "A value indicating the order of arrival of the Push operation in the Coveo Cloud V2 indexing pipeline. A lower value corresponds to an older operation. \nBy default, the service automatically sets this parameter to the current number of milliseconds since Unix Epoch. \nSpecifying a custom `orderingId` value is typically not recommended unless you know what you are doing and have a good reason to do so (see [About the orderingId parameter](https://docs.coveo.com/en/147/)). \n**Example:** `1506700606240`", "key": "orderingId", "value": "" }, { "description": "(Required) The unique identifier of the Amazon S3 file container into which the JSON definition of the content update was previously uploaded (see [Create a file container](https://docs.coveo.com/en/43/)). \n**Example:** d22778ca-7f42-4e13-9d9a-47d01bce866c", "key": "fileId", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "sourceId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Headers", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Methods", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Origin", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Content-Security-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-XSS-Protection", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:13.000Z", "updatedAt": "2026-07-28T01:29:13.000Z", "uid": "35240-d1ed241b-21df-4ad5-81f8-be27e754596e" }, { "id": "076f1a11-fa04-4b63-baa6-a3bc7b40240a", "name": "Precondition Failed", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/sources/:sourceId/documents/batch?orderingId=&fileId=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "sources", ":sourceId", "documents", "batch" ], "query": [ { "description": "A value indicating the order of arrival of the Push operation in the Coveo Cloud V2 indexing pipeline. A lower value corresponds to an older operation. \nBy default, the service automatically sets this parameter to the current number of milliseconds since Unix Epoch. \nSpecifying a custom `orderingId` value is typically not recommended unless you know what you are doing and have a good reason to do so (see [About the orderingId parameter](https://docs.coveo.com/en/147/)). \n**Example:** `1506700606240`", "key": "orderingId", "value": "" }, { "description": "(Required) The unique identifier of the Amazon S3 file container into which the JSON definition of the content update was previously uploaded (see [Create a file container](https://docs.coveo.com/en/43/)). \n**Example:** d22778ca-7f42-4e13-9d9a-47d01bce866c", "key": "fileId", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "sourceId" } ] } }, "status": "Precondition Failed", "code": 412, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Headers", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Methods", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Origin", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Content-Security-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-XSS-Protection", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:13.000Z", "updatedAt": "2026-07-28T01:29:13.000Z", "uid": "35240-076f1a11-fa04-4b63-baa6-a3bc7b40240a" }, { "id": "2a5877cc-5ea4-4c79-92f0-fcb3188c9c62", "name": "Unsupported Media Type", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/sources/:sourceId/documents/batch?orderingId=&fileId=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "sources", ":sourceId", "documents", "batch" ], "query": [ { "description": "A value indicating the order of arrival of the Push operation in the Coveo Cloud V2 indexing pipeline. A lower value corresponds to an older operation. \nBy default, the service automatically sets this parameter to the current number of milliseconds since Unix Epoch. \nSpecifying a custom `orderingId` value is typically not recommended unless you know what you are doing and have a good reason to do so (see [About the orderingId parameter](https://docs.coveo.com/en/147/)). \n**Example:** `1506700606240`", "key": "orderingId", "value": "" }, { "description": "(Required) The unique identifier of the Amazon S3 file container into which the JSON definition of the content update was previously uploaded (see [Create a file container](https://docs.coveo.com/en/43/)). \n**Example:** d22778ca-7f42-4e13-9d9a-47d01bce866c", "key": "fileId", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "sourceId" } ] } }, "status": "Unsupported Media Type", "code": 415, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Headers", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Methods", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Origin", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Content-Security-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-XSS-Protection", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:13.000Z", "updatedAt": "2026-07-28T01:29:13.000Z", "uid": "35240-2a5877cc-5ea4-4c79-92f0-fcb3188c9c62" }, { "id": "d7c9a7b5-f75c-44b0-8e23-492ddc194c71", "name": "Too many Requests", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/sources/:sourceId/documents/batch?orderingId=&fileId=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "sources", ":sourceId", "documents", "batch" ], "query": [ { "description": "A value indicating the order of arrival of the Push operation in the Coveo Cloud V2 indexing pipeline. A lower value corresponds to an older operation. \nBy default, the service automatically sets this parameter to the current number of milliseconds since Unix Epoch. \nSpecifying a custom `orderingId` value is typically not recommended unless you know what you are doing and have a good reason to do so (see [About the orderingId parameter](https://docs.coveo.com/en/147/)). \n**Example:** `1506700606240`", "key": "orderingId", "value": "" }, { "description": "(Required) The unique identifier of the Amazon S3 file container into which the JSON definition of the content update was previously uploaded (see [Create a file container](https://docs.coveo.com/en/43/)). \n**Example:** d22778ca-7f42-4e13-9d9a-47d01bce866c", "key": "fileId", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "sourceId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Headers", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Methods", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Origin", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Content-Security-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-XSS-Protection", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:13.000Z", "updatedAt": "2026-07-28T01:29:13.000Z", "uid": "35240-d7c9a7b5-f75c-44b0-8e23-492ddc194c71" }, { "id": "160113c5-e630-472f-9e8a-ddc3978b38f2", "name": "Internal Server Error", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/sources/:sourceId/documents/batch?orderingId=&fileId=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "sources", ":sourceId", "documents", "batch" ], "query": [ { "description": "A value indicating the order of arrival of the Push operation in the Coveo Cloud V2 indexing pipeline. A lower value corresponds to an older operation. \nBy default, the service automatically sets this parameter to the current number of milliseconds since Unix Epoch. \nSpecifying a custom `orderingId` value is typically not recommended unless you know what you are doing and have a good reason to do so (see [About the orderingId parameter](https://docs.coveo.com/en/147/)). \n**Example:** `1506700606240`", "key": "orderingId", "value": "" }, { "description": "(Required) The unique identifier of the Amazon S3 file container into which the JSON definition of the content update was previously uploaded (see [Create a file container](https://docs.coveo.com/en/43/)). \n**Example:** d22778ca-7f42-4e13-9d9a-47d01bce866c", "key": "fileId", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "sourceId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Headers", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Methods", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Origin", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Content-Security-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-XSS-Protection", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:13.000Z", "updatedAt": "2026-07-28T01:29:13.000Z", "uid": "35240-160113c5-e630-472f-9e8a-ddc3978b38f2" } ], "createdAt": "2026-07-28T01:29:13.000Z", "updatedAt": "2026-07-28T01:29:13.000Z", "uid": "35240-bd6ab330-3c40-4c63-a25d-15a55d664012" } ], "id": "c49ede92-f231-4042-8f3b-19a6bc2b70f8", "createdAt": "2026-07-28T01:29:13.000Z", "updatedAt": "2026-07-28T01:29:13.000Z", "uid": "35240-c49ede92-f231-4042-8f3b-19a6bc2b70f8" }, { "name": "olderthan", "item": [ { "name": "Delete Old Items", "id": "a02420a4-b8ff-4429-9cca-cc19128d882f", "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": [], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/sources/:sourceId/documents/olderthan?orderingId=&queueDelay=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "sources", ":sourceId", "documents", "olderthan" ], "query": [ { "description": "(Required) The lowest Push API operation timestamp value an item must be associated to in order not to be deleted from the Push source. \n**Example:** `1506700606240`", "key": "orderingId", "value": "" }, { "description": "A grace period (in minutes) whose purpose is to give the Coveo Cloud V2 indexing pipeline enough time to finish processing any previously enqueued operation that would affect the target Push source. Default value is 15 minutes. \n**Example:** `5`", "key": "queueDelay", "value": "" } ], "variable": [ { "id": "fcd38db3-fbbd-4862-8037-1eb6cdd193de", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target Coveo Cloud V2 organization. \n**Example:** `mycoveocloudv2organizationg8tp8wu3`" }, { "id": "edd6921f-4f8e-479a-8570-81222217cc87", "key": "sourceId", "value": "", "description": "(Required) The unique identifier of the target Push source (see [Creating a Push Source](https://developers.coveo.com/x/34s9Ag)). \n**Example:** `rp5rxzbdz753uhndklv2ztkfgy-mycoveocloudv2organizationg8tp8wu3`" } ] }, "description": "In a specific Push source, deletes all items whose last update was made by a Push API operation whose `orderingId` is strictly lower than a specified value." }, "response": [ { "id": "1e432d84-a0cb-4069-a24c-5b5c74dc4aa5", "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/sources/:sourceId/documents/olderthan?orderingId=&queueDelay=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "sources", ":sourceId", "documents", "olderthan" ], "query": [ { "description": "(Required) The lowest Push API operation timestamp value an item must be associated to in order not to be deleted from the Push source. \n**Example:** `1506700606240`", "key": "orderingId", "value": "" }, { "description": "A grace period (in minutes) whose purpose is to give the Coveo Cloud V2 indexing pipeline enough time to finish processing any previously enqueued operation that would affect the target Push source. Default value is 15 minutes. \n**Example:** `5`", "key": "queueDelay", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "sourceId" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Headers", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Methods", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Origin", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Content-Security-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-XSS-Protection", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:13.000Z", "updatedAt": "2026-07-28T01:29:13.000Z", "uid": "35240-1e432d84-a0cb-4069-a24c-5b5c74dc4aa5" }, { "id": "5494fa16-09ae-4aaf-b872-441ba9fc52f6", "name": "Bad request", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/sources/:sourceId/documents/olderthan?orderingId=&queueDelay=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "sources", ":sourceId", "documents", "olderthan" ], "query": [ { "description": "(Required) The lowest Push API operation timestamp value an item must be associated to in order not to be deleted from the Push source. \n**Example:** `1506700606240`", "key": "orderingId", "value": "" }, { "description": "A grace period (in minutes) whose purpose is to give the Coveo Cloud V2 indexing pipeline enough time to finish processing any previously enqueued operation that would affect the target Push source. Default value is 15 minutes. \n**Example:** `5`", "key": "queueDelay", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "sourceId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Headers", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Methods", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Origin", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Content-Security-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-XSS-Protection", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:13.000Z", "updatedAt": "2026-07-28T01:29:13.000Z", "uid": "35240-5494fa16-09ae-4aaf-b872-441ba9fc52f6" }, { "id": "cc22120a-55a6-4343-825f-6ee428c86d3d", "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/sources/:sourceId/documents/olderthan?orderingId=&queueDelay=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "sources", ":sourceId", "documents", "olderthan" ], "query": [ { "description": "(Required) The lowest Push API operation timestamp value an item must be associated to in order not to be deleted from the Push source. \n**Example:** `1506700606240`", "key": "orderingId", "value": "" }, { "description": "A grace period (in minutes) whose purpose is to give the Coveo Cloud V2 indexing pipeline enough time to finish processing any previously enqueued operation that would affect the target Push source. Default value is 15 minutes. \n**Example:** `5`", "key": "queueDelay", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "sourceId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Headers", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Methods", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Origin", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Content-Security-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-XSS-Protection", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:13.000Z", "updatedAt": "2026-07-28T01:29:13.000Z", "uid": "35240-cc22120a-55a6-4343-825f-6ee428c86d3d" }, { "id": "30aa40f5-de79-4d9e-b0bc-dd85d5c28108", "name": "Forbidden", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/sources/:sourceId/documents/olderthan?orderingId=&queueDelay=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "sources", ":sourceId", "documents", "olderthan" ], "query": [ { "description": "(Required) The lowest Push API operation timestamp value an item must be associated to in order not to be deleted from the Push source. \n**Example:** `1506700606240`", "key": "orderingId", "value": "" }, { "description": "A grace period (in minutes) whose purpose is to give the Coveo Cloud V2 indexing pipeline enough time to finish processing any previously enqueued operation that would affect the target Push source. Default value is 15 minutes. \n**Example:** `5`", "key": "queueDelay", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "sourceId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Headers", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Methods", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Origin", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Content-Security-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-XSS-Protection", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:13.000Z", "updatedAt": "2026-07-28T01:29:13.000Z", "uid": "35240-30aa40f5-de79-4d9e-b0bc-dd85d5c28108" }, { "id": "dde35fd0-1ee7-438f-bf6e-6c906e1410aa", "name": "Not found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/sources/:sourceId/documents/olderthan?orderingId=&queueDelay=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "sources", ":sourceId", "documents", "olderthan" ], "query": [ { "description": "(Required) The lowest Push API operation timestamp value an item must be associated to in order not to be deleted from the Push source. \n**Example:** `1506700606240`", "key": "orderingId", "value": "" }, { "description": "A grace period (in minutes) whose purpose is to give the Coveo Cloud V2 indexing pipeline enough time to finish processing any previously enqueued operation that would affect the target Push source. Default value is 15 minutes. \n**Example:** `5`", "key": "queueDelay", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "sourceId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Headers", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Methods", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Origin", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Content-Security-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-XSS-Protection", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:13.000Z", "updatedAt": "2026-07-28T01:29:13.000Z", "uid": "35240-dde35fd0-1ee7-438f-bf6e-6c906e1410aa" }, { "id": "51ccb78f-7fed-4eec-b57e-7ebc4d3c3af3", "name": "Precondition Failed", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/sources/:sourceId/documents/olderthan?orderingId=&queueDelay=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "sources", ":sourceId", "documents", "olderthan" ], "query": [ { "description": "(Required) The lowest Push API operation timestamp value an item must be associated to in order not to be deleted from the Push source. \n**Example:** `1506700606240`", "key": "orderingId", "value": "" }, { "description": "A grace period (in minutes) whose purpose is to give the Coveo Cloud V2 indexing pipeline enough time to finish processing any previously enqueued operation that would affect the target Push source. Default value is 15 minutes. \n**Example:** `5`", "key": "queueDelay", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "sourceId" } ] } }, "status": "Precondition Failed", "code": 412, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Headers", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Methods", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Origin", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Content-Security-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-XSS-Protection", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:13.000Z", "updatedAt": "2026-07-28T01:29:13.000Z", "uid": "35240-51ccb78f-7fed-4eec-b57e-7ebc4d3c3af3" }, { "id": "97ccd676-6342-4ae3-844b-fc3fc46bfc62", "name": "Unsupported Media Type", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/sources/:sourceId/documents/olderthan?orderingId=&queueDelay=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "sources", ":sourceId", "documents", "olderthan" ], "query": [ { "description": "(Required) The lowest Push API operation timestamp value an item must be associated to in order not to be deleted from the Push source. \n**Example:** `1506700606240`", "key": "orderingId", "value": "" }, { "description": "A grace period (in minutes) whose purpose is to give the Coveo Cloud V2 indexing pipeline enough time to finish processing any previously enqueued operation that would affect the target Push source. Default value is 15 minutes. \n**Example:** `5`", "key": "queueDelay", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "sourceId" } ] } }, "status": "Unsupported Media Type", "code": 415, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Headers", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Methods", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Origin", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Content-Security-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-XSS-Protection", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:13.000Z", "updatedAt": "2026-07-28T01:29:13.000Z", "uid": "35240-97ccd676-6342-4ae3-844b-fc3fc46bfc62" }, { "id": "30f27ead-e555-4303-9e13-425618a20ca2", "name": "Too many Requests", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/sources/:sourceId/documents/olderthan?orderingId=&queueDelay=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "sources", ":sourceId", "documents", "olderthan" ], "query": [ { "description": "(Required) The lowest Push API operation timestamp value an item must be associated to in order not to be deleted from the Push source. \n**Example:** `1506700606240`", "key": "orderingId", "value": "" }, { "description": "A grace period (in minutes) whose purpose is to give the Coveo Cloud V2 indexing pipeline enough time to finish processing any previously enqueued operation that would affect the target Push source. Default value is 15 minutes. \n**Example:** `5`", "key": "queueDelay", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "sourceId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Headers", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Methods", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Origin", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Content-Security-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-XSS-Protection", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:13.000Z", "updatedAt": "2026-07-28T01:29:13.000Z", "uid": "35240-30f27ead-e555-4303-9e13-425618a20ca2" }, { "id": "2e1c56aa-3e6c-433f-9faf-33432f10ebc9", "name": "Internal Server Error", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/sources/:sourceId/documents/olderthan?orderingId=&queueDelay=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "sources", ":sourceId", "documents", "olderthan" ], "query": [ { "description": "(Required) The lowest Push API operation timestamp value an item must be associated to in order not to be deleted from the Push source. \n**Example:** `1506700606240`", "key": "orderingId", "value": "" }, { "description": "A grace period (in minutes) whose purpose is to give the Coveo Cloud V2 indexing pipeline enough time to finish processing any previously enqueued operation that would affect the target Push source. Default value is 15 minutes. \n**Example:** `5`", "key": "queueDelay", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "sourceId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Headers", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Methods", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Origin", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Content-Security-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-XSS-Protection", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:13.000Z", "updatedAt": "2026-07-28T01:29:13.000Z", "uid": "35240-2e1c56aa-3e6c-433f-9faf-33432f10ebc9" } ], "createdAt": "2026-07-28T01:29:13.000Z", "updatedAt": "2026-07-28T01:29:13.000Z", "uid": "35240-a02420a4-b8ff-4429-9cca-cc19128d882f" } ], "id": "73360396-aba5-4aae-94f3-0e77efd1f4fb", "createdAt": "2026-07-28T01:29:13.000Z", "updatedAt": "2026-07-28T01:29:13.000Z", "uid": "35240-73360396-aba5-4aae-94f3-0e77efd1f4fb" }, { "name": "Delete an Item and Optionally Its Children", "id": "50782831-f34d-44d6-84e9-ef1bf5d69733", "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": [], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/sources/:sourceId/documents?orderingId=&deleteChildren=&documentId=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "sources", ":sourceId", "documents" ], "query": [ { "description": "A value indicating the order of arrival of the Push operation in the Coveo Cloud V2 indexing pipeline. A lower value corresponds to an older operation. \nBy default, the service automatically sets this parameter to the current number of milliseconds since Unix Epoch. \nSpecifying a custom `orderingId` value is typically not recommended unless you know what you are doing and have a good reason to do so (see [About the orderingId parameter](https://docs.coveo.com/en/147/)). \n**Example:** `1506700606240`", "key": "orderingId", "value": "" }, { "description": "Whether to also delete the children of the item.", "key": "deleteChildren", "value": "" }, { "description": "(Required) The unique identifier of the item. The Coveo item URI (see [Request parameters](https://docs.coveo.com/en/78/#query-parameters-add-update)). \n**Example:** `file://folder/my-file.html`", "key": "documentId", "value": "" } ], "variable": [ { "id": "aaad95ab-df69-4f57-aa17-3eff1e1d687b", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target Coveo Cloud V2 organization. \n**Example:** `mycoveocloudv2organizationg8tp8wu3`" }, { "id": "5e9d5323-1164-4da7-a309-ca8239977e54", "key": "sourceId", "value": "", "description": "(Required) The unique identifier of the target Push source (see [Creating a Push Source](https://developers.coveo.com/x/34s9Ag)). \n**Example:** `rp5rxzbdz753uhndklv2ztkfgy-mycoveocloudv2organizationg8tp8wu3`" } ] }, "description": "Deletes a specific item from a Push source. Optionally, the items of that item can also be deleted." }, "response": [ { "id": "57519719-7796-428b-91f3-acce6ad06919", "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/sources/:sourceId/documents?orderingId=&deleteChildren=&documentId=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "sources", ":sourceId", "documents" ], "query": [ { "description": "A value indicating the order of arrival of the Push operation in the Coveo Cloud V2 indexing pipeline. A lower value corresponds to an older operation. \nBy default, the service automatically sets this parameter to the current number of milliseconds since Unix Epoch. \nSpecifying a custom `orderingId` value is typically not recommended unless you know what you are doing and have a good reason to do so (see [About the orderingId parameter](https://docs.coveo.com/en/147/)). \n**Example:** `1506700606240`", "key": "orderingId", "value": "" }, { "description": "Whether to also delete the children of the item.", "key": "deleteChildren", "value": "" }, { "description": "(Required) The unique identifier of the item. The Coveo item URI (see [Request parameters](https://docs.coveo.com/en/78/#query-parameters-add-update)). \n**Example:** `file://folder/my-file.html`", "key": "documentId", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "sourceId" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Headers", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Methods", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Origin", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Content-Security-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-XSS-Protection", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:13.000Z", "updatedAt": "2026-07-28T01:29:13.000Z", "uid": "35240-57519719-7796-428b-91f3-acce6ad06919" }, { "id": "5c047a4b-494a-4a9e-959c-25012126dcae", "name": "Bad request", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/sources/:sourceId/documents?orderingId=&deleteChildren=&documentId=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "sources", ":sourceId", "documents" ], "query": [ { "description": "A value indicating the order of arrival of the Push operation in the Coveo Cloud V2 indexing pipeline. A lower value corresponds to an older operation. \nBy default, the service automatically sets this parameter to the current number of milliseconds since Unix Epoch. \nSpecifying a custom `orderingId` value is typically not recommended unless you know what you are doing and have a good reason to do so (see [About the orderingId parameter](https://docs.coveo.com/en/147/)). \n**Example:** `1506700606240`", "key": "orderingId", "value": "" }, { "description": "Whether to also delete the children of the item.", "key": "deleteChildren", "value": "" }, { "description": "(Required) The unique identifier of the item. The Coveo item URI (see [Request parameters](https://docs.coveo.com/en/78/#query-parameters-add-update)). \n**Example:** `file://folder/my-file.html`", "key": "documentId", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "sourceId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Headers", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Methods", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Origin", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Content-Security-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-XSS-Protection", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:13.000Z", "updatedAt": "2026-07-28T01:29:13.000Z", "uid": "35240-5c047a4b-494a-4a9e-959c-25012126dcae" }, { "id": "bc82f16b-1e2d-412e-a416-9e3ac4a43c93", "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/sources/:sourceId/documents?orderingId=&deleteChildren=&documentId=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "sources", ":sourceId", "documents" ], "query": [ { "description": "A value indicating the order of arrival of the Push operation in the Coveo Cloud V2 indexing pipeline. A lower value corresponds to an older operation. \nBy default, the service automatically sets this parameter to the current number of milliseconds since Unix Epoch. \nSpecifying a custom `orderingId` value is typically not recommended unless you know what you are doing and have a good reason to do so (see [About the orderingId parameter](https://docs.coveo.com/en/147/)). \n**Example:** `1506700606240`", "key": "orderingId", "value": "" }, { "description": "Whether to also delete the children of the item.", "key": "deleteChildren", "value": "" }, { "description": "(Required) The unique identifier of the item. The Coveo item URI (see [Request parameters](https://docs.coveo.com/en/78/#query-parameters-add-update)). \n**Example:** `file://folder/my-file.html`", "key": "documentId", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "sourceId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Headers", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Methods", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Origin", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Content-Security-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-XSS-Protection", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:13.000Z", "updatedAt": "2026-07-28T01:29:13.000Z", "uid": "35240-bc82f16b-1e2d-412e-a416-9e3ac4a43c93" }, { "id": "06695f7e-4b4c-4f7c-80b9-fb00197bdab4", "name": "Forbidden", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/sources/:sourceId/documents?orderingId=&deleteChildren=&documentId=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "sources", ":sourceId", "documents" ], "query": [ { "description": "A value indicating the order of arrival of the Push operation in the Coveo Cloud V2 indexing pipeline. A lower value corresponds to an older operation. \nBy default, the service automatically sets this parameter to the current number of milliseconds since Unix Epoch. \nSpecifying a custom `orderingId` value is typically not recommended unless you know what you are doing and have a good reason to do so (see [About the orderingId parameter](https://docs.coveo.com/en/147/)). \n**Example:** `1506700606240`", "key": "orderingId", "value": "" }, { "description": "Whether to also delete the children of the item.", "key": "deleteChildren", "value": "" }, { "description": "(Required) The unique identifier of the item. The Coveo item URI (see [Request parameters](https://docs.coveo.com/en/78/#query-parameters-add-update)). \n**Example:** `file://folder/my-file.html`", "key": "documentId", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "sourceId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Headers", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Methods", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Origin", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Content-Security-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-XSS-Protection", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:13.000Z", "updatedAt": "2026-07-28T01:29:13.000Z", "uid": "35240-06695f7e-4b4c-4f7c-80b9-fb00197bdab4" }, { "id": "9a24fc4d-2fa0-4603-8122-be25725e0a1b", "name": "Not found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/sources/:sourceId/documents?orderingId=&deleteChildren=&documentId=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "sources", ":sourceId", "documents" ], "query": [ { "description": "A value indicating the order of arrival of the Push operation in the Coveo Cloud V2 indexing pipeline. A lower value corresponds to an older operation. \nBy default, the service automatically sets this parameter to the current number of milliseconds since Unix Epoch. \nSpecifying a custom `orderingId` value is typically not recommended unless you know what you are doing and have a good reason to do so (see [About the orderingId parameter](https://docs.coveo.com/en/147/)). \n**Example:** `1506700606240`", "key": "orderingId", "value": "" }, { "description": "Whether to also delete the children of the item.", "key": "deleteChildren", "value": "" }, { "description": "(Required) The unique identifier of the item. The Coveo item URI (see [Request parameters](https://docs.coveo.com/en/78/#query-parameters-add-update)). \n**Example:** `file://folder/my-file.html`", "key": "documentId", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "sourceId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Headers", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Methods", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Origin", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Content-Security-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-XSS-Protection", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:13.000Z", "updatedAt": "2026-07-28T01:29:13.000Z", "uid": "35240-9a24fc4d-2fa0-4603-8122-be25725e0a1b" }, { "id": "717f5c3a-85cd-47d6-b53a-9192c4edd634", "name": "Precondition Failed", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/sources/:sourceId/documents?orderingId=&deleteChildren=&documentId=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "sources", ":sourceId", "documents" ], "query": [ { "description": "A value indicating the order of arrival of the Push operation in the Coveo Cloud V2 indexing pipeline. A lower value corresponds to an older operation. \nBy default, the service automatically sets this parameter to the current number of milliseconds since Unix Epoch. \nSpecifying a custom `orderingId` value is typically not recommended unless you know what you are doing and have a good reason to do so (see [About the orderingId parameter](https://docs.coveo.com/en/147/)). \n**Example:** `1506700606240`", "key": "orderingId", "value": "" }, { "description": "Whether to also delete the children of the item.", "key": "deleteChildren", "value": "" }, { "description": "(Required) The unique identifier of the item. The Coveo item URI (see [Request parameters](https://docs.coveo.com/en/78/#query-parameters-add-update)). \n**Example:** `file://folder/my-file.html`", "key": "documentId", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "sourceId" } ] } }, "status": "Precondition Failed", "code": 412, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Headers", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Methods", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Origin", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Content-Security-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-XSS-Protection", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:13.000Z", "updatedAt": "2026-07-28T01:29:13.000Z", "uid": "35240-717f5c3a-85cd-47d6-b53a-9192c4edd634" }, { "id": "3d473626-04d5-40f8-b940-4d365bb57334", "name": "Unsupported Media Type", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/sources/:sourceId/documents?orderingId=&deleteChildren=&documentId=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "sources", ":sourceId", "documents" ], "query": [ { "description": "A value indicating the order of arrival of the Push operation in the Coveo Cloud V2 indexing pipeline. A lower value corresponds to an older operation. \nBy default, the service automatically sets this parameter to the current number of milliseconds since Unix Epoch. \nSpecifying a custom `orderingId` value is typically not recommended unless you know what you are doing and have a good reason to do so (see [About the orderingId parameter](https://docs.coveo.com/en/147/)). \n**Example:** `1506700606240`", "key": "orderingId", "value": "" }, { "description": "Whether to also delete the children of the item.", "key": "deleteChildren", "value": "" }, { "description": "(Required) The unique identifier of the item. The Coveo item URI (see [Request parameters](https://docs.coveo.com/en/78/#query-parameters-add-update)). \n**Example:** `file://folder/my-file.html`", "key": "documentId", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "sourceId" } ] } }, "status": "Unsupported Media Type", "code": 415, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Headers", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Methods", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Origin", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Content-Security-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-XSS-Protection", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:13.000Z", "updatedAt": "2026-07-28T01:29:13.000Z", "uid": "35240-3d473626-04d5-40f8-b940-4d365bb57334" }, { "id": "f7300b27-2e78-481d-afe2-d305ead3cd4c", "name": "Too many Requests", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/sources/:sourceId/documents?orderingId=&deleteChildren=&documentId=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "sources", ":sourceId", "documents" ], "query": [ { "description": "A value indicating the order of arrival of the Push operation in the Coveo Cloud V2 indexing pipeline. A lower value corresponds to an older operation. \nBy default, the service automatically sets this parameter to the current number of milliseconds since Unix Epoch. \nSpecifying a custom `orderingId` value is typically not recommended unless you know what you are doing and have a good reason to do so (see [About the orderingId parameter](https://docs.coveo.com/en/147/)). \n**Example:** `1506700606240`", "key": "orderingId", "value": "" }, { "description": "Whether to also delete the children of the item.", "key": "deleteChildren", "value": "" }, { "description": "(Required) The unique identifier of the item. The Coveo item URI (see [Request parameters](https://docs.coveo.com/en/78/#query-parameters-add-update)). \n**Example:** `file://folder/my-file.html`", "key": "documentId", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "sourceId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Headers", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Methods", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Origin", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Content-Security-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-XSS-Protection", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:13.000Z", "updatedAt": "2026-07-28T01:29:13.000Z", "uid": "35240-f7300b27-2e78-481d-afe2-d305ead3cd4c" }, { "id": "292cd357-9363-4746-b6f6-09eb0c151236", "name": "Internal Server Error", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/sources/:sourceId/documents?orderingId=&deleteChildren=&documentId=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "sources", ":sourceId", "documents" ], "query": [ { "description": "A value indicating the order of arrival of the Push operation in the Coveo Cloud V2 indexing pipeline. A lower value corresponds to an older operation. \nBy default, the service automatically sets this parameter to the current number of milliseconds since Unix Epoch. \nSpecifying a custom `orderingId` value is typically not recommended unless you know what you are doing and have a good reason to do so (see [About the orderingId parameter](https://docs.coveo.com/en/147/)). \n**Example:** `1506700606240`", "key": "orderingId", "value": "" }, { "description": "Whether to also delete the children of the item.", "key": "deleteChildren", "value": "" }, { "description": "(Required) The unique identifier of the item. The Coveo item URI (see [Request parameters](https://docs.coveo.com/en/78/#query-parameters-add-update)). \n**Example:** `file://folder/my-file.html`", "key": "documentId", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "sourceId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Headers", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Methods", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Origin", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Content-Security-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-XSS-Protection", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:13.000Z", "updatedAt": "2026-07-28T01:29:13.000Z", "uid": "35240-292cd357-9363-4746-b6f6-09eb0c151236" } ], "createdAt": "2026-07-28T01:29:13.000Z", "updatedAt": "2026-07-28T01:29:13.000Z", "uid": "35240-50782831-f34d-44d6-84e9-ef1bf5d69733" }, { "name": "Add or Update an Item", "id": "ab0ac99c-9236-49d8-95ed-a37e6e4d0e14", "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": [], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/sources/:sourceId/documents?orderingId=&documentId=&compressionType=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "sources", ":sourceId", "documents" ], "query": [ { "description": "A value indicating the order of arrival of the Push operation in the Coveo Cloud V2 indexing pipeline. A lower value corresponds to an older operation. \nBy default, the service automatically sets this parameter to the current number of milliseconds since Unix Epoch. \nSpecifying a custom `orderingId` value is typically not recommended unless you know what you are doing and have a good reason to do so (see [About the orderingId parameter](https://docs.coveo.com/en/147/)). \n**Example:** `1506700606240`", "key": "orderingId", "value": "" }, { "description": "(Required) The unique identifier of the item. The Coveo item URI (see [Request parameters](https://docs.coveo.com/en/78/#query-parameters-add-update)). \n**Example:** `file://folder/my-file.html`", "key": "documentId", "value": "" }, { "description": "The algorithm that was used to compress the item data. \nSpecifying a value for this parameter is only necessary when using the `compressedBinaryData` or the `compressedBinaryDataFileId` property to push item data (see [Push source item data](https://docs.coveo.com/en/73/)). \nThe possible values are: `Uncompressed`, `ZLib`, `GZip`, `LZMA`, and `Deflate`. \n**Example:** `ZLib` (This can only be one of UNCOMPRESSED,ZLIB,GZIP,LZMA,DEFLATE)", "key": "compressionType", "value": "" } ], "variable": [ { "id": "5ed59b97-5219-4929-8c42-fe44bd57495e", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target Coveo Cloud V2 organization. \n**Example:** `mycoveocloudv2organizationg8tp8wu3`" }, { "id": "0da79657-dda1-40bc-a8b4-90efc4c86eaf", "key": "sourceId", "value": "", "description": "(Required) The unique identifier of the target Push source (see [Creating a Push Source](https://developers.coveo.com/x/34s9Ag)). \n**Example:** `rp5rxzbdz753uhndklv2ztkfgy-mycoveocloudv2organizationg8tp8wu3`" } ] }, "description": "Adds or updates an individual item in a Push source." }, "response": [ { "id": "0e26933e-bc1d-42f3-8ff2-b2b6d70fd56e", "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/sources/:sourceId/documents?orderingId=&documentId=&compressionType=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "sources", ":sourceId", "documents" ], "query": [ { "description": "A value indicating the order of arrival of the Push operation in the Coveo Cloud V2 indexing pipeline. A lower value corresponds to an older operation. \nBy default, the service automatically sets this parameter to the current number of milliseconds since Unix Epoch. \nSpecifying a custom `orderingId` value is typically not recommended unless you know what you are doing and have a good reason to do so (see [About the orderingId parameter](https://docs.coveo.com/en/147/)). \n**Example:** `1506700606240`", "key": "orderingId", "value": "" }, { "description": "(Required) The unique identifier of the item. The Coveo item URI (see [Request parameters](https://docs.coveo.com/en/78/#query-parameters-add-update)). \n**Example:** `file://folder/my-file.html`", "key": "documentId", "value": "" }, { "description": "The algorithm that was used to compress the item data. \nSpecifying a value for this parameter is only necessary when using the `compressedBinaryData` or the `compressedBinaryDataFileId` property to push item data (see [Push source item data](https://docs.coveo.com/en/73/)). \nThe possible values are: `Uncompressed`, `ZLib`, `GZip`, `LZMA`, and `Deflate`. \n**Example:** `ZLib` (This can only be one of UNCOMPRESSED,ZLIB,GZIP,LZMA,DEFLATE)", "key": "compressionType", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "sourceId" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Headers", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Methods", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Origin", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Content-Security-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-XSS-Protection", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:13.000Z", "updatedAt": "2026-07-28T01:29:13.000Z", "uid": "35240-0e26933e-bc1d-42f3-8ff2-b2b6d70fd56e" }, { "id": "0dfce793-3759-4cd9-b670-31916de2bea0", "name": "Bad request", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/sources/:sourceId/documents?orderingId=&documentId=&compressionType=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "sources", ":sourceId", "documents" ], "query": [ { "description": "A value indicating the order of arrival of the Push operation in the Coveo Cloud V2 indexing pipeline. A lower value corresponds to an older operation. \nBy default, the service automatically sets this parameter to the current number of milliseconds since Unix Epoch. \nSpecifying a custom `orderingId` value is typically not recommended unless you know what you are doing and have a good reason to do so (see [About the orderingId parameter](https://docs.coveo.com/en/147/)). \n**Example:** `1506700606240`", "key": "orderingId", "value": "" }, { "description": "(Required) The unique identifier of the item. The Coveo item URI (see [Request parameters](https://docs.coveo.com/en/78/#query-parameters-add-update)). \n**Example:** `file://folder/my-file.html`", "key": "documentId", "value": "" }, { "description": "The algorithm that was used to compress the item data. \nSpecifying a value for this parameter is only necessary when using the `compressedBinaryData` or the `compressedBinaryDataFileId` property to push item data (see [Push source item data](https://docs.coveo.com/en/73/)). \nThe possible values are: `Uncompressed`, `ZLib`, `GZip`, `LZMA`, and `Deflate`. \n**Example:** `ZLib` (This can only be one of UNCOMPRESSED,ZLIB,GZIP,LZMA,DEFLATE)", "key": "compressionType", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "sourceId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Headers", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Methods", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Origin", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Content-Security-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-XSS-Protection", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:13.000Z", "updatedAt": "2026-07-28T01:29:13.000Z", "uid": "35240-0dfce793-3759-4cd9-b670-31916de2bea0" }, { "id": "ff68420d-d104-4779-974b-24749c4199c9", "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/sources/:sourceId/documents?orderingId=&documentId=&compressionType=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "sources", ":sourceId", "documents" ], "query": [ { "description": "A value indicating the order of arrival of the Push operation in the Coveo Cloud V2 indexing pipeline. A lower value corresponds to an older operation. \nBy default, the service automatically sets this parameter to the current number of milliseconds since Unix Epoch. \nSpecifying a custom `orderingId` value is typically not recommended unless you know what you are doing and have a good reason to do so (see [About the orderingId parameter](https://docs.coveo.com/en/147/)). \n**Example:** `1506700606240`", "key": "orderingId", "value": "" }, { "description": "(Required) The unique identifier of the item. The Coveo item URI (see [Request parameters](https://docs.coveo.com/en/78/#query-parameters-add-update)). \n**Example:** `file://folder/my-file.html`", "key": "documentId", "value": "" }, { "description": "The algorithm that was used to compress the item data. \nSpecifying a value for this parameter is only necessary when using the `compressedBinaryData` or the `compressedBinaryDataFileId` property to push item data (see [Push source item data](https://docs.coveo.com/en/73/)). \nThe possible values are: `Uncompressed`, `ZLib`, `GZip`, `LZMA`, and `Deflate`. \n**Example:** `ZLib` (This can only be one of UNCOMPRESSED,ZLIB,GZIP,LZMA,DEFLATE)", "key": "compressionType", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "sourceId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Headers", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Methods", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Origin", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Content-Security-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-XSS-Protection", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:13.000Z", "updatedAt": "2026-07-28T01:29:13.000Z", "uid": "35240-ff68420d-d104-4779-974b-24749c4199c9" }, { "id": "a18555fc-1b69-44ff-8de6-d1fc84953fc0", "name": "Forbidden", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/sources/:sourceId/documents?orderingId=&documentId=&compressionType=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "sources", ":sourceId", "documents" ], "query": [ { "description": "A value indicating the order of arrival of the Push operation in the Coveo Cloud V2 indexing pipeline. A lower value corresponds to an older operation. \nBy default, the service automatically sets this parameter to the current number of milliseconds since Unix Epoch. \nSpecifying a custom `orderingId` value is typically not recommended unless you know what you are doing and have a good reason to do so (see [About the orderingId parameter](https://docs.coveo.com/en/147/)). \n**Example:** `1506700606240`", "key": "orderingId", "value": "" }, { "description": "(Required) The unique identifier of the item. The Coveo item URI (see [Request parameters](https://docs.coveo.com/en/78/#query-parameters-add-update)). \n**Example:** `file://folder/my-file.html`", "key": "documentId", "value": "" }, { "description": "The algorithm that was used to compress the item data. \nSpecifying a value for this parameter is only necessary when using the `compressedBinaryData` or the `compressedBinaryDataFileId` property to push item data (see [Push source item data](https://docs.coveo.com/en/73/)). \nThe possible values are: `Uncompressed`, `ZLib`, `GZip`, `LZMA`, and `Deflate`. \n**Example:** `ZLib` (This can only be one of UNCOMPRESSED,ZLIB,GZIP,LZMA,DEFLATE)", "key": "compressionType", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "sourceId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Headers", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Methods", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Origin", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Content-Security-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-XSS-Protection", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:13.000Z", "updatedAt": "2026-07-28T01:29:13.000Z", "uid": "35240-a18555fc-1b69-44ff-8de6-d1fc84953fc0" }, { "id": "a9cd0610-9e97-40fb-a402-bff4412a8b79", "name": "Not found", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/sources/:sourceId/documents?orderingId=&documentId=&compressionType=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "sources", ":sourceId", "documents" ], "query": [ { "description": "A value indicating the order of arrival of the Push operation in the Coveo Cloud V2 indexing pipeline. A lower value corresponds to an older operation. \nBy default, the service automatically sets this parameter to the current number of milliseconds since Unix Epoch. \nSpecifying a custom `orderingId` value is typically not recommended unless you know what you are doing and have a good reason to do so (see [About the orderingId parameter](https://docs.coveo.com/en/147/)). \n**Example:** `1506700606240`", "key": "orderingId", "value": "" }, { "description": "(Required) The unique identifier of the item. The Coveo item URI (see [Request parameters](https://docs.coveo.com/en/78/#query-parameters-add-update)). \n**Example:** `file://folder/my-file.html`", "key": "documentId", "value": "" }, { "description": "The algorithm that was used to compress the item data. \nSpecifying a value for this parameter is only necessary when using the `compressedBinaryData` or the `compressedBinaryDataFileId` property to push item data (see [Push source item data](https://docs.coveo.com/en/73/)). \nThe possible values are: `Uncompressed`, `ZLib`, `GZip`, `LZMA`, and `Deflate`. \n**Example:** `ZLib` (This can only be one of UNCOMPRESSED,ZLIB,GZIP,LZMA,DEFLATE)", "key": "compressionType", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "sourceId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Headers", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Methods", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Origin", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Content-Security-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-XSS-Protection", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:13.000Z", "updatedAt": "2026-07-28T01:29:13.000Z", "uid": "35240-a9cd0610-9e97-40fb-a402-bff4412a8b79" }, { "id": "77b572b4-5df1-4ef3-a4c0-4717605e606c", "name": "Precondition Failed", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/sources/:sourceId/documents?orderingId=&documentId=&compressionType=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "sources", ":sourceId", "documents" ], "query": [ { "description": "A value indicating the order of arrival of the Push operation in the Coveo Cloud V2 indexing pipeline. A lower value corresponds to an older operation. \nBy default, the service automatically sets this parameter to the current number of milliseconds since Unix Epoch. \nSpecifying a custom `orderingId` value is typically not recommended unless you know what you are doing and have a good reason to do so (see [About the orderingId parameter](https://docs.coveo.com/en/147/)). \n**Example:** `1506700606240`", "key": "orderingId", "value": "" }, { "description": "(Required) The unique identifier of the item. The Coveo item URI (see [Request parameters](https://docs.coveo.com/en/78/#query-parameters-add-update)). \n**Example:** `file://folder/my-file.html`", "key": "documentId", "value": "" }, { "description": "The algorithm that was used to compress the item data. \nSpecifying a value for this parameter is only necessary when using the `compressedBinaryData` or the `compressedBinaryDataFileId` property to push item data (see [Push source item data](https://docs.coveo.com/en/73/)). \nThe possible values are: `Uncompressed`, `ZLib`, `GZip`, `LZMA`, and `Deflate`. \n**Example:** `ZLib` (This can only be one of UNCOMPRESSED,ZLIB,GZIP,LZMA,DEFLATE)", "key": "compressionType", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "sourceId" } ] } }, "status": "Precondition Failed", "code": 412, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Headers", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Methods", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Origin", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Content-Security-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-XSS-Protection", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:13.000Z", "updatedAt": "2026-07-28T01:29:13.000Z", "uid": "35240-77b572b4-5df1-4ef3-a4c0-4717605e606c" }, { "id": "49d23cb2-25af-4e5b-9933-81d7c4c4b123", "name": "Unsupported Media Type", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/sources/:sourceId/documents?orderingId=&documentId=&compressionType=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "sources", ":sourceId", "documents" ], "query": [ { "description": "A value indicating the order of arrival of the Push operation in the Coveo Cloud V2 indexing pipeline. A lower value corresponds to an older operation. \nBy default, the service automatically sets this parameter to the current number of milliseconds since Unix Epoch. \nSpecifying a custom `orderingId` value is typically not recommended unless you know what you are doing and have a good reason to do so (see [About the orderingId parameter](https://docs.coveo.com/en/147/)). \n**Example:** `1506700606240`", "key": "orderingId", "value": "" }, { "description": "(Required) The unique identifier of the item. The Coveo item URI (see [Request parameters](https://docs.coveo.com/en/78/#query-parameters-add-update)). \n**Example:** `file://folder/my-file.html`", "key": "documentId", "value": "" }, { "description": "The algorithm that was used to compress the item data. \nSpecifying a value for this parameter is only necessary when using the `compressedBinaryData` or the `compressedBinaryDataFileId` property to push item data (see [Push source item data](https://docs.coveo.com/en/73/)). \nThe possible values are: `Uncompressed`, `ZLib`, `GZip`, `LZMA`, and `Deflate`. \n**Example:** `ZLib` (This can only be one of UNCOMPRESSED,ZLIB,GZIP,LZMA,DEFLATE)", "key": "compressionType", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "sourceId" } ] } }, "status": "Unsupported Media Type", "code": 415, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Headers", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Methods", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Origin", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Content-Security-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-XSS-Protection", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:13.000Z", "updatedAt": "2026-07-28T01:29:13.000Z", "uid": "35240-49d23cb2-25af-4e5b-9933-81d7c4c4b123" }, { "id": "2d45b701-55bb-4db3-b04b-4589968688f6", "name": "Too many Requests", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/sources/:sourceId/documents?orderingId=&documentId=&compressionType=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "sources", ":sourceId", "documents" ], "query": [ { "description": "A value indicating the order of arrival of the Push operation in the Coveo Cloud V2 indexing pipeline. A lower value corresponds to an older operation. \nBy default, the service automatically sets this parameter to the current number of milliseconds since Unix Epoch. \nSpecifying a custom `orderingId` value is typically not recommended unless you know what you are doing and have a good reason to do so (see [About the orderingId parameter](https://docs.coveo.com/en/147/)). \n**Example:** `1506700606240`", "key": "orderingId", "value": "" }, { "description": "(Required) The unique identifier of the item. The Coveo item URI (see [Request parameters](https://docs.coveo.com/en/78/#query-parameters-add-update)). \n**Example:** `file://folder/my-file.html`", "key": "documentId", "value": "" }, { "description": "The algorithm that was used to compress the item data. \nSpecifying a value for this parameter is only necessary when using the `compressedBinaryData` or the `compressedBinaryDataFileId` property to push item data (see [Push source item data](https://docs.coveo.com/en/73/)). \nThe possible values are: `Uncompressed`, `ZLib`, `GZip`, `LZMA`, and `Deflate`. \n**Example:** `ZLib` (This can only be one of UNCOMPRESSED,ZLIB,GZIP,LZMA,DEFLATE)", "key": "compressionType", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "sourceId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Headers", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Methods", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Origin", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Content-Security-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-XSS-Protection", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:13.000Z", "updatedAt": "2026-07-28T01:29:13.000Z", "uid": "35240-2d45b701-55bb-4db3-b04b-4589968688f6" }, { "id": "a43710ea-5b53-4d91-bc77-90a03f6baa21", "name": "Internal Server Error", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/sources/:sourceId/documents?orderingId=&documentId=&compressionType=", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "sources", ":sourceId", "documents" ], "query": [ { "description": "A value indicating the order of arrival of the Push operation in the Coveo Cloud V2 indexing pipeline. A lower value corresponds to an older operation. \nBy default, the service automatically sets this parameter to the current number of milliseconds since Unix Epoch. \nSpecifying a custom `orderingId` value is typically not recommended unless you know what you are doing and have a good reason to do so (see [About the orderingId parameter](https://docs.coveo.com/en/147/)). \n**Example:** `1506700606240`", "key": "orderingId", "value": "" }, { "description": "(Required) The unique identifier of the item. The Coveo item URI (see [Request parameters](https://docs.coveo.com/en/78/#query-parameters-add-update)). \n**Example:** `file://folder/my-file.html`", "key": "documentId", "value": "" }, { "description": "The algorithm that was used to compress the item data. \nSpecifying a value for this parameter is only necessary when using the `compressedBinaryData` or the `compressedBinaryDataFileId` property to push item data (see [Push source item data](https://docs.coveo.com/en/73/)). \nThe possible values are: `Uncompressed`, `ZLib`, `GZip`, `LZMA`, and `Deflate`. \n**Example:** `ZLib` (This can only be one of UNCOMPRESSED,ZLIB,GZIP,LZMA,DEFLATE)", "key": "compressionType", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "sourceId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Headers", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Methods", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Access-Control-Allow-Origin", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Content-Security-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-XSS-Protection", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:13.000Z", "updatedAt": "2026-07-28T01:29:13.000Z", "uid": "35240-a43710ea-5b53-4d91-bc77-90a03f6baa21" } ], "createdAt": "2026-07-28T01:29:13.000Z", "updatedAt": "2026-07-28T01:29:13.000Z", "uid": "35240-ab0ac99c-9236-49d8-95ed-a37e6e4d0e14" } ], "id": "24b694fd-37f2-4602-a9e0-495983da89bb", "createdAt": "2026-07-28T01:29:13.000Z", "updatedAt": "2026-07-28T01:29:13.000Z", "uid": "35240-24b694fd-37f2-4602-a9e0-495983da89bb" } ], "id": "93c5245b-7d0a-45a4-baf8-f1047dedfc19", "createdAt": "2026-07-28T01:29:13.000Z", "updatedAt": "2026-07-28T01:29:13.000Z", "uid": "35240-93c5245b-7d0a-45a4-baf8-f1047dedfc19" } ], "id": "ad2a5b42-69ec-477a-9430-c45eac898b13", "createdAt": "2026-07-28T01:29:13.000Z", "updatedAt": "2026-07-28T01:29:13.000Z", "uid": "35240-ad2a5b42-69ec-477a-9430-c45eac898b13" } ], "id": "5cb17432-8a64-4e81-b56e-513fe20e431a", "createdAt": "2026-07-28T01:29:13.000Z", "updatedAt": "2026-07-28T01:29:13.000Z", "uid": "35240-5cb17432-8a64-4e81-b56e-513fe20e431a" } ], "id": "9ce8ebd7-1fb0-440d-9a72-ea996e7e54c1", "createdAt": "2026-07-28T01:29:13.000Z", "updatedAt": "2026-07-28T01:29:13.000Z", "uid": "35240-9ce8ebd7-1fb0-440d-9a72-ea996e7e54c1" } ], "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" } ] }