> For the complete documentation index, see [llms.txt](https://help.openloyalty.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.openloyalty.io/api-reference/bulk-action.md).

# Bulk Action

These endpoints will allow you to easily manage bulk actions in system.

## Create bulk action

> \<label style="background-color: #D4EDBC;padding:5px;">Management\</label>\<br>\<br><br>

````json
{"openapi":"3.0.0","info":{"title":"Open Loyalty","version":"0.0.1"},"tags":[{"name":"Bulk Action","description":"These endpoints will allow you to easily manage bulk actions in system."}],"servers":[{"url":"http://openloyalty.localhost"}],"security":[{"Bearer":[]},{"token":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"Open Loyalty has the JWT authorization.\nTo learn what a JSON Web Token is and how it works, check out Introduction to JSON Web Tokens <https://jwt.io/introduction/>\n\n### Obtain an access token\n\nSend a request with the parameters username and password\n\n#### Definition\n\n`POST /api/admin/login_check` [Go to definition](#operation/adminLoginCheck)\\\n`POST /api/{storeCode}/member/login_check` [Go to definition](#operation/memberLoginCheck)\n\n#### Example\n\n```bash\ncurl {HOST}/api/admin/login_check\n    -H 'Content-Type: application/json;charset=UTF-8'\n    -H 'Accept: application/json, text/plain, */*'\n    --data-binary '{\"username\":\"admin\",\"password\":\"password\"}'\n```\n\n#### Example Response\n\n```json\n{\n    \"token\":\"eyJhbGciOiJSUzI1NiIsInR5cCI6...\",\n    \"refresh_token\":\"0558f8bb29948c4e54c443f...\"\n}\n```\n\n### Using JSON Web Token\n\nAdd authorization header to each request\\\n`Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...`\\\nYou can now access any API method you want under the /api prefix.\n\n#### Example\n```bash\ncurl {HOST}/api/{storeCode}/analytics/members\n    -H 'Accept: application/json'\n    -H 'Content-type: application/x-www-form-urlencoded'\n    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...'\n```\n\n### Refresh JSON Web Token\nYou can refresh token using refresh_token that was given during login.\\\nThere are two endpoints\\\nTo refresh admin token `POST /api/token/refresh` [Go to definition](#operation/tokenRefresh)\\\nTo refresh member token `POST /api/{storeCode}/token/refresh` [Go to definition](#operation/tokenRefreshMember)\n","name":"Authorization","in":"header","bearerFormat":"JWT","scheme":"bearer"},"token":{"type":"apiKey","name":"X-AUTH-TOKEN","in":"header"}},"parameters":{"storeCode":{"name":"storeCode","in":"path","description":"Store code","required":true,"schema":{"type":"string"}}},"schemas":{"cancelTransfersTypeRequestBody":{"title":"cancelTransfersTypeRequestBody","properties":{"cancelTransfers":{"required":["requestedAt"],"properties":{"requestedAt":{"type":"string","format":"date-time"},"criteria":{"$ref":"#/components/schemas/criteriaObject"}},"type":"object"}},"type":"object","additionalProperties":false},"criteriaObject":{"properties":{"pending":{"type":"boolean"},"createdAt":{"$ref":"#/components/schemas/DateTimeCriteriaField"},"transferId":{"type":"string","format":"uuid"},"walletId":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["adding","spending","expired","blocked","p2p_adding","p2p_spending"]},"value":{"$ref":"#/components/schemas/NumericCriteriaField"},"comment":{"type":"string"},"createdBy":{"type":"string","format":"uuid"},"registeredOn":{"$ref":"#/components/schemas/DateTimeCriteriaField"},"lockedUntil":{"$ref":"#/components/schemas/DateTimeCriteriaField"},"expiresAt":{"$ref":"#/components/schemas/DateTimeCriteriaField"},"cancelled":{"type":"boolean"},"actionCause:transactionId":{"type":"string","format":"uuid"},"actionCause:customerId":{"type":"string","format":"uuid"},"actionCause:campaignId":{"type":"string","format":"uuid"},"actionCause:customerEventId":{"type":"string","format":"uuid"},"actionCause:internalEventName":{"type":"string","format":"uuid"},"actionCause:campaignName":{"type":"string"},"walletType:code":{"type":"string"},"member:id":{"type":"string","format":"uuid"},"member:email":{"type":"string"},"member:phoneNumber":{"type":"string"},"member:loyaltyCardNumber":{"type":"string"}},"type":"object"},"DateTimeCriteriaField":{"oneOf":[{"description":"Date and time value","type":"string","format":"date-time"},{"description":"Date and time value with optional comparison operators like lt (less than), gt (greater than), etc.","properties":{"lt":{"description":"Less than the specified date-time","type":"string","format":"date-time"},"lte":{"description":"Less than or equal to the specified date-time","type":"string","format":"date-time"},"gt":{"description":"Greater than the specified date-time","type":"string","format":"date-time"},"gte":{"description":"Greater than or equal to the specified date-time","type":"string","format":"date-time"},"eq":{"description":"Equal to the specified date-time","type":"string","format":"date-time"}},"type":"object"}]},"NumericCriteriaField":{"oneOf":[{"description":"Date and time value","type":"integer"},{"description":"Number value with optional comparison operators like lt (less than), gt (greater than), etc.","properties":{"lt":{"description":"Less than the specified number","type":"integer"},"lte":{"description":"Less than or equal to the specified number","type":"integer"},"gt":{"description":"Greater than the specified number","type":"integer"},"gte":{"description":"Greater than or equal to the specified number","type":"integer"},"eq":{"description":"Equal to the specified number","type":"integer"}},"type":"object"}]},"activateTransfersTypeRequestBody":{"title":"activateTransfersTypeRequestBody","properties":{"activateTransfers":{"required":["requestedAt"],"properties":{"requestedAt":{"type":"string","format":"date-time"},"criteria":{"$ref":"#/components/schemas/criteriaObject"}},"type":"object"}},"type":"object","additionalProperties":false},"expireTransfersTypeRequestBody":{"title":"expireTransfersTypeRequestBody","description":"Use `changeExpirationTransfers` instead\n","properties":{"expireTransfers":{"required":["requestedAt"],"properties":{"requestedAt":{"type":"string","format":"date-time"},"criteria":{"$ref":"#/components/schemas/criteriaObject"}},"type":"object"}},"type":"object","deprecated":true,"additionalProperties":false},"changeExpirationTransfersTypeRequestBody":{"title":"changeExpirationTransfersTypeRequestBody","properties":{"changeExpirationTransfers":{"required":["requestedAt","parameters"],"properties":{"requestedAt":{"type":"string","format":"date-time"},"criteria":{"$ref":"#/components/schemas/criteriaObject"},"parameters":{"required":["expiresAt"],"properties":{"expiresAt":{"description":"Transfer expiration date. Null removes the expiration date.\n","type":"string","format":"date-time","nullable":true}},"type":"object","additionalProperties":false},"comment":{"type":"string","maxLength":500}},"type":"object"}},"type":"object","additionalProperties":false}},"responses":{"BadRequest":{"description":"Bad request.","content":{"application/json":{"schema":{"required":["code","message","errors"],"properties":{"code":{"type":"integer"},"message":{"type":"string"},"errors":{"type":"array","items":{"required":["message","parameters","plural","code","path"],"properties":{"message":{"type":"string"},"parameters":{},"plural":{"type":"integer","nullable":true},"code":{"type":"string"},"path":{"type":"string"}},"type":"object"}}},"type":"object"}}}},"AccessDenied":{"description":"Forbidden.","content":{"application/json":{"schema":{"required":["code","message"],"properties":{"code":{"type":"integer"},"message":{"type":"string"}},"type":"object"}}}},"NotFound":{"description":"Not found.","content":{"application/json":{"schema":{"required":["code","message"],"properties":{"code":{"type":"integer"},"message":{"type":"string"}},"type":"object"}}}}}},"paths":{"/api/{storeCode}/bulkAction/{type}":{"post":{"tags":["Bulk Action"],"summary":"Create bulk action","description":"<label style=\"background-color: #D4EDBC;padding:5px;\">Management</label><br><br>\n","operationId":"_postBulkAction","parameters":[{"$ref":"#/components/parameters/storeCode"},{"name":"type","in":"path","description":"Bulk Action Type","required":true,"schema":{"type":"string","enum":["cancelTransfers","activateTransfers","expireTransfers","changeExpirationTransfers"]}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/cancelTransfersTypeRequestBody"},{"$ref":"#/components/schemas/activateTransfersTypeRequestBody"},{"$ref":"#/components/schemas/expireTransfersTypeRequestBody"},{"$ref":"#/components/schemas/changeExpirationTransfersTypeRequestBody"}]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"required":["bulkActionId"],"properties":{"bulkActionId":{"type":"string","format":"uuid"}},"type":"object","additionalProperties":false}}}},"400":{"$ref":"#/components/responses/BadRequest"},"403":{"$ref":"#/components/responses/AccessDenied"},"404":{"$ref":"#/components/responses/NotFound"}}}}}}
````

## Get bulk actions

> \<label style="background-color: #D4EDBC;padding:5px;">Management\</label>\<br>\<br><br>

````json
{"openapi":"3.0.0","info":{"title":"Open Loyalty","version":"0.0.1"},"tags":[{"name":"Bulk Action","description":"These endpoints will allow you to easily manage bulk actions in system."}],"servers":[{"url":"http://openloyalty.localhost"}],"security":[{"Bearer":[]},{"token":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"Open Loyalty has the JWT authorization.\nTo learn what a JSON Web Token is and how it works, check out Introduction to JSON Web Tokens <https://jwt.io/introduction/>\n\n### Obtain an access token\n\nSend a request with the parameters username and password\n\n#### Definition\n\n`POST /api/admin/login_check` [Go to definition](#operation/adminLoginCheck)\\\n`POST /api/{storeCode}/member/login_check` [Go to definition](#operation/memberLoginCheck)\n\n#### Example\n\n```bash\ncurl {HOST}/api/admin/login_check\n    -H 'Content-Type: application/json;charset=UTF-8'\n    -H 'Accept: application/json, text/plain, */*'\n    --data-binary '{\"username\":\"admin\",\"password\":\"password\"}'\n```\n\n#### Example Response\n\n```json\n{\n    \"token\":\"eyJhbGciOiJSUzI1NiIsInR5cCI6...\",\n    \"refresh_token\":\"0558f8bb29948c4e54c443f...\"\n}\n```\n\n### Using JSON Web Token\n\nAdd authorization header to each request\\\n`Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...`\\\nYou can now access any API method you want under the /api prefix.\n\n#### Example\n```bash\ncurl {HOST}/api/{storeCode}/analytics/members\n    -H 'Accept: application/json'\n    -H 'Content-type: application/x-www-form-urlencoded'\n    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...'\n```\n\n### Refresh JSON Web Token\nYou can refresh token using refresh_token that was given during login.\\\nThere are two endpoints\\\nTo refresh admin token `POST /api/token/refresh` [Go to definition](#operation/tokenRefresh)\\\nTo refresh member token `POST /api/{storeCode}/token/refresh` [Go to definition](#operation/tokenRefreshMember)\n","name":"Authorization","in":"header","bearerFormat":"JWT","scheme":"bearer"},"token":{"type":"apiKey","name":"X-AUTH-TOKEN","in":"header"}},"parameters":{"storeCode":{"name":"storeCode","in":"path","description":"Store code","required":true,"schema":{"type":"string"}},"page":{"name":"_page","in":"query","description":"Number of page with results, starts from 1","required":false,"schema":{"type":"integer","default":1,"minimum":1}},"itemsOnPage":{"name":"_itemsOnPage","in":"query","description":"Items on one page","required":false,"schema":{"type":"integer","default":10,"maximum":50,"minimum":1}},"orderBy":{"name":"_orderBy","in":"query","description":"Sorting order. If sorting is not chosen, the rows will be returned in an unspecified order. Sort order: * `asc` - Ascending, from A to Z * `desc` - Descending, from Z to A","required":false,"style":"deepObject","explode":true,"schema":{"type":"object","additionalProperties":{"type":"string","enum":["asc","desc"]}}}},"schemas":{"bulkAction":{"required":["bulkActionId","requestedAt","criteria","resource","type"],"properties":{"bulkActionId":{"type":"string","format":"uuid"},"requestedAt":{"type":"string","format":"date-time"},"criteria":{"$ref":"#/components/schemas/criteriaObject"},"resource":{"type":"string"},"type":{"type":"string","enum":["cancelTransfers","activateTransfers","expireTransfers","changeExpirationTransfers"]},"processedRowCount":{"type":"integer"},"message":{"type":"string"},"userId":{"type":"string","format":"uuid"},"email":{"type":"string"},"comment":{"type":"string"}},"type":"object"},"criteriaObject":{"properties":{"pending":{"type":"boolean"},"createdAt":{"$ref":"#/components/schemas/DateTimeCriteriaField"},"transferId":{"type":"string","format":"uuid"},"walletId":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["adding","spending","expired","blocked","p2p_adding","p2p_spending"]},"value":{"$ref":"#/components/schemas/NumericCriteriaField"},"comment":{"type":"string"},"createdBy":{"type":"string","format":"uuid"},"registeredOn":{"$ref":"#/components/schemas/DateTimeCriteriaField"},"lockedUntil":{"$ref":"#/components/schemas/DateTimeCriteriaField"},"expiresAt":{"$ref":"#/components/schemas/DateTimeCriteriaField"},"cancelled":{"type":"boolean"},"actionCause:transactionId":{"type":"string","format":"uuid"},"actionCause:customerId":{"type":"string","format":"uuid"},"actionCause:campaignId":{"type":"string","format":"uuid"},"actionCause:customerEventId":{"type":"string","format":"uuid"},"actionCause:internalEventName":{"type":"string","format":"uuid"},"actionCause:campaignName":{"type":"string"},"walletType:code":{"type":"string"},"member:id":{"type":"string","format":"uuid"},"member:email":{"type":"string"},"member:phoneNumber":{"type":"string"},"member:loyaltyCardNumber":{"type":"string"}},"type":"object"},"DateTimeCriteriaField":{"oneOf":[{"description":"Date and time value","type":"string","format":"date-time"},{"description":"Date and time value with optional comparison operators like lt (less than), gt (greater than), etc.","properties":{"lt":{"description":"Less than the specified date-time","type":"string","format":"date-time"},"lte":{"description":"Less than or equal to the specified date-time","type":"string","format":"date-time"},"gt":{"description":"Greater than the specified date-time","type":"string","format":"date-time"},"gte":{"description":"Greater than or equal to the specified date-time","type":"string","format":"date-time"},"eq":{"description":"Equal to the specified date-time","type":"string","format":"date-time"}},"type":"object"}]},"NumericCriteriaField":{"oneOf":[{"description":"Date and time value","type":"integer"},{"description":"Number value with optional comparison operators like lt (less than), gt (greater than), etc.","properties":{"lt":{"description":"Less than the specified number","type":"integer"},"lte":{"description":"Less than or equal to the specified number","type":"integer"},"gt":{"description":"Greater than the specified number","type":"integer"},"gte":{"description":"Greater than or equal to the specified number","type":"integer"},"eq":{"description":"Equal to the specified number","type":"integer"}},"type":"object"}]},"SearchableTotalResponse":{"required":["all","filtered","estimated"],"properties":{"all":{"type":"integer","deprecated":true},"filtered":{"type":"integer","deprecated":true},"estimated":{"description":"Field estimated is used to show that the results are estimated. It might happen when there are more than 5000 results due to performance optimization.","type":"boolean","deprecated":true}},"type":"object","deprecated":true}},"responses":{"BadRequest":{"description":"Bad request.","content":{"application/json":{"schema":{"required":["code","message","errors"],"properties":{"code":{"type":"integer"},"message":{"type":"string"},"errors":{"type":"array","items":{"required":["message","parameters","plural","code","path"],"properties":{"message":{"type":"string"},"parameters":{},"plural":{"type":"integer","nullable":true},"code":{"type":"string"},"path":{"type":"string"}},"type":"object"}}},"type":"object"}}}},"AccessDenied":{"description":"Forbidden.","content":{"application/json":{"schema":{"required":["code","message"],"properties":{"code":{"type":"integer"},"message":{"type":"string"}},"type":"object"}}}},"NotFound":{"description":"Not found.","content":{"application/json":{"schema":{"required":["code","message"],"properties":{"code":{"type":"integer"},"message":{"type":"string"}},"type":"object"}}}}}},"paths":{"/api/{storeCode}/bulkAction":{"get":{"tags":["Bulk Action"],"summary":"Get bulk actions","description":"<label style=\"background-color: #D4EDBC;padding:5px;\">Management</label><br><br>\n","operationId":"_getBulkActions","parameters":[{"$ref":"#/components/parameters/storeCode"},{"name":"type","in":"path","description":"Bulk Action Type","required":false,"schema":{"type":"string","enum":["cancelTransfers","activateTransfers","expireTransfers","changeExpirationTransfers"]}},{"name":"requestedAt","in":"query","description":"Date and time when the action was requested by admin","required":false,"schema":{"type":"string","format":"date-time"}},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/itemsOnPage"},{"$ref":"#/components/parameters/orderBy"}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/bulkAction"}},"total":{"$ref":"#/components/schemas/SearchableTotalResponse"}},"type":"object"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"403":{"$ref":"#/components/responses/AccessDenied"},"404":{"$ref":"#/components/responses/NotFound"}}}}}}
````

## Get bulk action items

> \<label style="background-color: #D4EDBC;padding:5px;">Management\</label>\<br>\<br><br>

````json
{"openapi":"3.0.0","info":{"title":"Open Loyalty","version":"0.0.1"},"tags":[{"name":"Bulk Action","description":"These endpoints will allow you to easily manage bulk actions in system."}],"servers":[{"url":"http://openloyalty.localhost"}],"security":[{"Bearer":[]},{"token":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"Open Loyalty has the JWT authorization.\nTo learn what a JSON Web Token is and how it works, check out Introduction to JSON Web Tokens <https://jwt.io/introduction/>\n\n### Obtain an access token\n\nSend a request with the parameters username and password\n\n#### Definition\n\n`POST /api/admin/login_check` [Go to definition](#operation/adminLoginCheck)\\\n`POST /api/{storeCode}/member/login_check` [Go to definition](#operation/memberLoginCheck)\n\n#### Example\n\n```bash\ncurl {HOST}/api/admin/login_check\n    -H 'Content-Type: application/json;charset=UTF-8'\n    -H 'Accept: application/json, text/plain, */*'\n    --data-binary '{\"username\":\"admin\",\"password\":\"password\"}'\n```\n\n#### Example Response\n\n```json\n{\n    \"token\":\"eyJhbGciOiJSUzI1NiIsInR5cCI6...\",\n    \"refresh_token\":\"0558f8bb29948c4e54c443f...\"\n}\n```\n\n### Using JSON Web Token\n\nAdd authorization header to each request\\\n`Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...`\\\nYou can now access any API method you want under the /api prefix.\n\n#### Example\n```bash\ncurl {HOST}/api/{storeCode}/analytics/members\n    -H 'Accept: application/json'\n    -H 'Content-type: application/x-www-form-urlencoded'\n    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...'\n```\n\n### Refresh JSON Web Token\nYou can refresh token using refresh_token that was given during login.\\\nThere are two endpoints\\\nTo refresh admin token `POST /api/token/refresh` [Go to definition](#operation/tokenRefresh)\\\nTo refresh member token `POST /api/{storeCode}/token/refresh` [Go to definition](#operation/tokenRefreshMember)\n","name":"Authorization","in":"header","bearerFormat":"JWT","scheme":"bearer"},"token":{"type":"apiKey","name":"X-AUTH-TOKEN","in":"header"}},"parameters":{"storeCode":{"name":"storeCode","in":"path","description":"Store code","required":true,"schema":{"type":"string"}},"page":{"name":"_page","in":"query","description":"Number of page with results, starts from 1","required":false,"schema":{"type":"integer","default":1,"minimum":1}},"itemsOnPage":{"name":"_itemsOnPage","in":"query","description":"Items on one page","required":false,"schema":{"type":"integer","default":10,"maximum":50,"minimum":1}},"orderBy":{"name":"_orderBy","in":"query","description":"Sorting order. If sorting is not chosen, the rows will be returned in an unspecified order. Sort order: * `asc` - Ascending, from A to Z * `desc` - Descending, from Z to A","required":false,"style":"deepObject","explode":true,"schema":{"type":"object","additionalProperties":{"type":"string","enum":["asc","desc"]}}}},"schemas":{"bulkActionItem":{"required":["bulkActionItemId","status","createdAt","updatedAt","type","objectToProcessId"],"properties":{"bulkActionItemId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["queued","inprogress","completed","failed","error"]},"type":{"type":"string","enum":["cancelTransfers","activateTransfers","expireTransfers","changeExpirationTransfers"]},"objectToProcessId":{"type":"string"},"message":{"type":"string"}},"type":"object"},"SearchableTotalResponse":{"required":["all","filtered","estimated"],"properties":{"all":{"type":"integer","deprecated":true},"filtered":{"type":"integer","deprecated":true},"estimated":{"description":"Field estimated is used to show that the results are estimated. It might happen when there are more than 5000 results due to performance optimization.","type":"boolean","deprecated":true}},"type":"object","deprecated":true}},"responses":{"BadRequest":{"description":"Bad request.","content":{"application/json":{"schema":{"required":["code","message","errors"],"properties":{"code":{"type":"integer"},"message":{"type":"string"},"errors":{"type":"array","items":{"required":["message","parameters","plural","code","path"],"properties":{"message":{"type":"string"},"parameters":{},"plural":{"type":"integer","nullable":true},"code":{"type":"string"},"path":{"type":"string"}},"type":"object"}}},"type":"object"}}}},"AccessDenied":{"description":"Forbidden.","content":{"application/json":{"schema":{"required":["code","message"],"properties":{"code":{"type":"integer"},"message":{"type":"string"}},"type":"object"}}}},"NotFound":{"description":"Not found.","content":{"application/json":{"schema":{"required":["code","message"],"properties":{"code":{"type":"integer"},"message":{"type":"string"}},"type":"object"}}}}}},"paths":{"/api/{storeCode}/bulkAction/{bulkActionId}/item":{"get":{"tags":["Bulk Action"],"summary":"Get bulk action items","description":"<label style=\"background-color: #D4EDBC;padding:5px;\">Management</label><br><br>\n","operationId":"_getBulkActionItems","parameters":[{"$ref":"#/components/parameters/storeCode"},{"name":"bulkActionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"objectToProcessId","in":"query","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"createdAt","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"updatedAt","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["queued","inprogress","completed","failed","error"]}},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/itemsOnPage"},{"$ref":"#/components/parameters/orderBy"}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/bulkActionItem"}},"total":{"$ref":"#/components/schemas/SearchableTotalResponse"}},"type":"object"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"403":{"$ref":"#/components/responses/AccessDenied"},"404":{"$ref":"#/components/responses/NotFound"}}}}}}
````


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://help.openloyalty.io/api-reference/bulk-action.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
