PATCH /payout-request-batches/{id}
Partially updates a payout request batch with a specified ID. Use this operation to update the description and allocation order.
Servers
- https://api-sandbox.rebilly.com/organizations/{organizationId}
- https://api.rebilly.com/organizations/{organizationId}
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
description |
String | No |
Description of the batch.
Omit this property when not updating the description.
Do not send |
allocationOrder[] |
Array | No |
Order for auto-allocation of payout requests in this batch.
When set, this field overrides the organization-level allocation order during batch auto-allocation.
Must contain |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.