Skip to main content
POST
/
api
/
v1
/
accounts
/
{account-id}
/
auto-claims
Create an account-wide auto-claim schedule
curl --request POST \
  --url https://app.crown-brlv.com/api/v1/accounts/{account-id}/auto-claims \
  --header 'Content-Type: application/json' \
  --data '
{
  "max-amount": "100.00",
  "cron": "0 9 * * *",
  "target-asset-code": "brlv"
}
'
{
  "auto-claim-schedule": {
    "last-run-at": "<string>",
    "cron": "0 9 * * *",
    "max-amount": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created-at": "<string>",
    "enabled": true,
    "wallet-address": "<string>"
  }
}

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