Skip to main content
POST
/
v2
/
apps
/
{app_id}
/
change_settings
Update an application's settings
curl --request POST \
  --url https://api.dots.dev/api/v2/apps/{app_id}/change_settings \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "payout_options_exclude_list": [
    "<string>"
  ],
  "auto_refill_active": true,
  "refill_amount": 500500,
  "refill_threshold": 500500,
  "customer_payout_fee_table": {
    "ach": {
      "fixed": 100,
      "percent": "0.01",
      "min": 0
    },
    "paypal": {
      "fixed": 50,
      "percent": "0.02",
      "min": 25
    }
  }
}
'
{
  "payout_options_exclude_list": [
    "<string>"
  ],
  "auto_refill_active": true,
  "refill_amount": 123,
  "refill_threshold": 123,
  "customer_payout_fee_table": {}
}

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

app_id
string<UUID>
required

ID of the app to update.

Body

application/json
payout_options_exclude_list
string[]

List of payout options to exclude

auto_refill_active
boolean

Enable or disable auto refill

refill_amount
integer

Amount to refill when the threshold is reached

Required range: 1000 <= x <= 1000000
refill_threshold
integer

Threshold for triggering a refill

Required range: 1000 <= x <= 1000000
customer_payout_fee_table
object

Fee table to configure fee upcharges charged to payees. Contact the Dots team to enable this functionality. Set to null to clear the fee table. Keys can be rail names (e.g., "ach", "paypal") or rail/currency combinations (e.g., "bank_transfer/eur"). Use "defaults" key for fallback fees.

Example:
{
"ach": { "fixed": 100, "percent": "0.01", "min": 0 },
"paypal": { "fixed": 50, "percent": "0.02", "min": 25 }
}

Response

Successfully updated settings

payout_options_exclude_list
string[]
auto_refill_active
boolean
refill_amount
integer
refill_threshold
integer
customer_payout_fee_table
object

Custom fee table for customer payouts