Aggregate member

Calling this endpoint initiates an aggregation event for the member. This brings in the latest account and transaction data from the connected institution. If this data has recently been updated, MX may not initiate an aggregation event.

POST

/users/{user_guid}/members/{member_guid}/aggregate

Path Parameters

Field	Required	Type

member_guid The unique id for a `member`.	Required	String

user_guid The unique identifier for a `user`, beginning with the prefix `USR-`.	Required	String

Query Parameters

Field	Required	Type

include_holdings When set to `false`, the aggregation will not gather holdings data. Defaults to `true`.	Optional	Boolean

include_transactions When set to `false`, the aggregation will not gather transactions data. Defaults to `true`.	Optional	Boolean

Header Parameters

Field	Required	Type
X-CALLBACK-PAYLOAD The base64 encoded string defined in this header will be returned in the Member and Member Data Updated webhooks. This allows you to trace user interactions and workflows initiated externally and internally in the MX Platform. Max 1024 characters.	Optional	String

Field

Required

Type

X-CALLBACK-PAYLOAD

The base64 encoded string defined in this header will be returned in the Member and Member Data Updated webhooks. This allows you to trace user interactions and workflows initiated externally and internally in the MX Platform. Max 1024 characters.

Optional

String