Sign in

v1

latestOpenAPI 3.0.22026-07-24113565544.0 KB
AutoPilot

Create Autopilot Run

Create an Autopilot Run.

post/managed/autopilot/{partnerID}

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": [
    "cc07f91b-7ee1-4868-b8fc-823c70a1b932.1407775317759"
  ]
}

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_ebf7e764-e2d6-4b3d-a333-b8ff05b92b89",
  "created": "2022-12-27T06:06:28.955Z",
  "status": "REBALANCE_NOT_STARTED",
  "riaID": "66304da9-3h6f-2234-935f-ac6b7933d706"
}