Knowledge Center

Knowledge Center > API > REST API > REST API Reference > Mass Updater > Stop Mass Action

Stop Mass Action

This reference describes how to stop a mass action through the REST API. You can stop a mass action when its status is Pending or Processing. After you have stopped a mass action, you can get the mass action result to see details of the mass action.

  • If you stop a mass action when its status is Pending, no response file is generated because no records have been processed.
  • If you stop a mass action when its status is Processing, a response file is generated. You can check the response file to see which records have been processed and which have not. In the response file, the Success column has the value Y (successful) or N (failed) for processed records, and a blank value for unprocessed records.

Records that have already been processed when a mass action is stopped are not rolled back.

Request

  • Production: PUT https://api.zuora.com/rest/v1/bulk/{bulk-key}/stop
  • API Sandbox: PUT https://apisandbox-api.zuora.com/rest/v1/bulk/{bulk-key}/stop

Request Header

The Accept request header is optional. Only JSON is returned.

Request Parameters

bulk-key

required

path

String of 32 characters that identifies a mass action. You get the bulk-key after performing a mass action through the REST API.

Response

Response Body

success

Returns true if the request is successful. Otherwise, returns false.

processId

The internal process ID used to assist Zuora support. Returned only if success is false.

reasons

Information describing the reason for the result. Returned only if success is false.

code

An eight-digit numeric error code.

message

A description of the error.

Example

HTTP Request

PUT https://api.zuora.com/rest/v1/bulk/402892f04c97b89a014c97bb30a50003/stop

JSON Response

{
"success": true
}
Last modified
18:44, 11 Oct 2015

Tags

This page has no custom tags.

Classifications

(not set)