Update a scheduled fiat withdrawal

Updates frequency, frequency day, and minimum balance on a schedule. Allowed only from ACTIVE or PAUSED; rejected from CANCELLED. Returns 404 for deleted or missing schedules. The next scheduled run will be recalculated when frequency or frequency day changes.

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

Schedule ID

Body Params
string
enum

Sweep cadence. Omit to keep the schedule's current frequency.

Allowed:
int32

Day selector. Omit to keep the schedule's current day (or to leave it null when switching to DAILY). Must be null for DAILY; 1-7 (Monday=1) for WEEKLY; 1-31 for MONTHLY.

minimumAmount
object

Optional minimum the net swept amount must reach for a withdrawal to be created. Omit to leave it unchanged, or send null to remove the minimum entirely.

number

Balance floor in major units of the schedule's currency. Omit to keep the schedule's current floor. Only the excess above this floor is swept.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

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