docs
  1. Admin Api
  2. Resources
  3. Bulk Requests
  4. Cancel Bulk Request

Cancel bulk request

Cancel a bulk request.

Rate Limit: 300 Max attempts within 1 minute.

Path Parameters

ParameterDetails
requestKey
  • required
integer

Responses

200
Bulk request was successfully cancelled.
application/json
Success
keyrequired
integer
Example:
123
statusrequired
string
Example:
cancelled
object
400
Bad Request
application/json
Error
401
Unauthorized
application/json
Error
404
Not Found
application/json
Error
PUT/bulk-requests/{requestKey}/cancel

Request samples

Response samples

200
CancelBulkRequestResponse:
Content type: application/json
Provide Feedback