Nexus API
Aggregate member
Use this endpoint to create a new aggregation job, which is the process that gathers updated account, transaction, and holding data for a given member. If you've set the use_cases field when creating the member, then the member's use_case must be set to PFM, otherwise a 403 will return. The response will include important information about the member's aggregation including the is_being_aggregated and connection_status fields. The aggregation can take some time to finish; you can use the the read member endpoint and track the status and completion of the aggregation as it progresses.
Path Parameters
| Field | Required | Type |
|---|---|---|
member_guid The unique identifier for the member. Defined by MX. | Required | String |
Request Body
| Field | Required | Type |
|---|---|---|
include_holdings When set to | Optional | Boolean |
include_transactions When set to | Optional | Boolean |