Update member

This request was previously documented as non-rooted or not wrapped in the "member" object. We have added backwards compatibility to partners coded to the non-rooted format but all new integrations will use rooted requests as documented below. The use of this endpoint to answer an MFA challenge and resume aggregation has been deprecated. Partners should use the resume aggregation endpoint in its place, as outlined in the Nexus guide. MX continues to support partners who leverage the update member endpoint for this purpose, but MX encourages all partners to switch to the resume aggregation endpoint instead.

This endpoint should be used to update a member's credentials, e.g., login and password, when the member's connection_status is DENIED or PREVENTED. Partners should make a request to the list member credentials endpoint to get the list of that member's required credentials before gathering them from the user and making a request to the update member endpoint. An aggregation job will be initiated automatically when a member's credentials are updated unless the skip_aggregation field is used to prevent it. However, a new job will not be initiated if there is already a job in process for that member.

The skip_aggregation field should not be provided with a value of true when the update member endpoint is being used to answer an MFA challenge. That said, the best practice is to use the newer resume aggregation endpoint to answer MFA challenges. This endpoint accepts the optional MX-Skip-Webhook header and skip_webhook parameter.

PUT

/members/{member_guid}

Path Parameters

Field	Required	Type
member_guid The unique identifier for the member. Defined by MX.	Required	String

Request Body

The parameters to update a member.

Field	Required	Type
member	Required	Object

Loading...