Skip to main content
POST
Create an account-wide auto-claim schedule

Path Parameters

account-id
string<uuid>
required

Body

application/json
max-amount
required

Claim up to this amount each run; if less is available, claims what's available

Example:

"100.00"

cron
string
required

UNIX cron expression (5 fields). Must fire at most once per day

Example:

"0 9 * * *"

target-asset-code
enum<string>

Destination asset: 'brl' for bank transfer or 'brlv' for on-chain tokens

Available options:
brl,
brlv
Example:

"brlv"

Response

Auto-claim schedule created

auto-claim-schedule
object
required

The auto-claim schedule