API reference

Create bulk action

post
https://sandbox.numeral.io/v1/bulk_actions

Create a bulk action on a list of items.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required

The object related to the bulk action.

Allowed:
string
enum
required

The action to execute on the items included in the bulk action.

If target_action is payment_order, can be create, approve or cancel. If target_action is internal_account, can be create.

Allowed:
boolean

When set to true, if any item in items has an invalid payload, the bulk action will not be created. When set to false, the bulk action will be created and all items with valid payloads will be processed, whereas items with invalid payloads will be counted as failed. The default value is true.

items
array of objects
required
length between 1 and 5000
items*
Responses

400

Bad request. Validation error or missing required fields.

401

Unauthorized. API key is missing or invalid.

500

Internal server error.

Updated 7 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago