Update bulk operation

Update an existing bulk operation. Used to modify operation parameters or retry failed rules.

put/bulk-operations/{id}

Request

Base URL
https://commerce_studio_id.experiencemanager.lucidworks.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/lucidworks/apis/rules-rewrites-api/docs/bulk-operations/:id/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

Bulk operation ID.

Query parameters

fieldsstring[]

Fields to include in the response.

Headers

If-Matchstring

ETag value for optimistic concurrency control.

Request body

Example request

{
  "type": "deleteRule",
  "specification": {
    "publishState": "DRAFT",
    "lastModifiedEnd": "2026-01-01T00:00:00Z"
  },
  "excludeRuleIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ]
}

Response

Example response

{
  "type": "deleteRule",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdBy": "fe56a9d2-f6eb-4906-f7fc-dd5eb0e43337@serviceaccounts.examplepetstore.com",
  "creationDate": "2026-07-13T18:04:12.190428685Z",
  "lastModifiedBy": "fe56a9d2-f6eb-4906-f7fc-dd5eb0e43337@serviceaccounts.examplepetstore.com",
  "lastModified": "2026-07-13T18:04:14.902428685Z",
  "status": "COMPLETED",
  "lastHeartbeat": "2026-07-13T18:04:14.900484876Z",
  "errorMessage": null,
  "rules": [
    {
      "ruleId": "af2d99c0-3d11-4002-a5d0-835b673d7f32",
      "status": "COMPLETED",
      "errorMessage": null,
      "detailedErrorMessage": null
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.