Force item(s) for a Sandbox User into an error state
POST /sandbox/user/reset_login
/sandbox/user/reset_login/ functions the same as /sandbox/item/reset_login, but will modify Items related to a User. This endpoint forces each Item into an ITEM_LOGIN_REQUIRED state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link's update mode flow in the Sandbox environment. After calling /sandbox/user/reset_login, You can then use Plaid Link update mode to restore Items associated with the User to a good state. An ITEM_LOGIN_REQUIRED webhook will also be fired after a call to this endpoint, if one is associated with the Item.
In the Sandbox, Items will transition to an ITEM_LOGIN_REQUIRED error state automatically after 30 days, even if this endpoint is not called.
Request Body
Required
SandboxUserResetLoginRequest defines the request schema for /sandbox/user/reset_login
Parameters
client_id
client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.
secret
secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.
user_token
item_ids
item_ids associated with the User to be reset. If empty or null, this field will default to resetting all Items associated with the User.
Response
SandboxUserResetLoginResponse defines the response schema for /sandbox/user/reset_login
Response Properties
request_id