Skip to main content
POST
/
wealth
/
accounts
/
{account_id}
/
auto-invest
curl --request POST \
  --url https://api.bluumfinance.com/v1/wealth/accounts/{account_id}/auto-invest \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Monthly Investment",
  "portfolio_id": "port_a1b2c3d4e5f6",
  "funding_source_id": "fs_123456789",
  "amount": "500.00",
  "currency": "USD",
  "frequency": "monthly",
  "schedule": {
    "day_of_month": 15,
    "time": "09:30"
  },
  "allocation_rule": "ips_target",
  "start_date": "2025-02-15",
  "notifications": {
    "on_execution": true,
    "on_failure": true
  }
}
'
{
  "auto_invest_id": "ai_a1b2c3d4e5f6",
  "account_id": "3d0b0e65-35d3-4dcd-8df7-10286ebb4b4b",
  "portfolio_id": "port_a1b2c3d4e5f6",
  "name": "Monthly Investment",
  "amount": "500.00",
  "currency": "USD",
  "frequency": "monthly",
  "schedule": {
    "day_of_month": 15,
    "time": "09:30"
  },
  "allocation_rule": "ips_target",
  "funding_source_id": "fs_123456789",
  "start_date": "2025-02-15",
  "next_execution": "2025-02-15T09:30:00Z",
  "status": "active",
  "notifications": {
    "on_execution": true,
    "on_failure": true
  },
  "created_at": "2025-01-15T10:00:00Z",
  "updated_at": "2025-01-15T10:00:00Z"
}

Authorizations

​
Authorization
string
header
required

HTTP Basic Authentication using the API Key as username and API Secret as password.

Headers

​
Idempotency-Key
string
Maximum string length: 128

Path Parameters

​
account_id
string<uuid>
required

Body

application/json

Request to create/update auto-invest schedule

​
name
string
required
Required string length: 1 - 100
​
portfolio_id
string<uuid>
required
​
funding_source_id
string<uuid>
required
​
amount
string
required
Pattern: ^\d+(\.\d{2})?$
​
frequency
enum<string>
required
Available options:
weekly,
biweekly,
monthly,
quarterly
​
allocation_rule
enum<string>
required
Available options:
ips_target,
equal_weight,
custom
​
currency
string
default:USD
Pattern: ^[A-Z]{3}$
​
schedule
object
​
custom_allocation
object
​
start_date
string<date>
​
end_date
string<date>
​
notifications
object

Response

Auto-invest schedule created successfully

Automated investment schedule

​
auto_invest_id
string<uuid>
​
account_id
string<uuid>
​
portfolio_id
string<uuid>
​
name
string
Example:

"Monthly Investment"

​
amount
string

Amount to invest per execution

​
currency
string
Pattern: ^[A-Z]{3}$
​
frequency
enum<string>
Available options:
weekly,
biweekly,
monthly,
quarterly
​
schedule
object
​
allocation_rule
enum<string>
Available options:
ips_target,
equal_weight,
custom
​
custom_allocation
object

Symbol to percentage mapping (if rule=custom)

​
funding_source_id
string<uuid>
​
start_date
string<date>
​
end_date
string<date>
​
next_execution
string<date-time>