DRdrivewealth
AutoPilot

Create Autopilot Run

Create an Autopilot Run.

post/managed/autopilot/{partnerID}

Request

  • Base URL
    https://bo-api.drivewealth.io/back-office
  • URL
    https://bo-api.drivewealth.io/back-office/managed/autopilot/{partnerID}
  • Auth
    HTTP bearer

Path parameters

partnerIDstring required

This is the parentIBID or userID of the registered investment advisor.

Request body

reviewOnlyboolean required

True, if a review should occur without a forced rebalance.

forceRebalanceboolean required

True, if a forces rebalance should occur.

subAccountsAccountID[]

A list of user's accountIDs to be rebalanced.

Example request

{
  "reviewOnly": true,
  "forceRebalance": true,
  "subAccounts": [
    "123e4567-e89b-12d3-a456-000000000004.1234567890125"
  ]
}

Response

Creating an Autopilot Run was Successful.

idstring

The unique re-balance run identifier rebalanceRunID associated with a specific re-balance.

createdstring

A timestamp of when the re-balance run was created.

statusstring

Status of the re-balance run. See Autopilot Run Status for status values.

riaIDstring

This is the parentIBID or userID of the registered investment advisor creating the re-balance run.

Example response

{
  "id": "ria_rebalance_123e4567-e89b-12d3-a456-000000000012",
  "created": "2022-12-27T06:06:28.955Z",
  "status": "REBALANCE_NOT_STARTED",
  "riaID": "123e4567-e89b-12d3-a456-000000000167"
}

Changes

No recorded changes to this operation across all 1 revision of this API.