Update individual fields on an external account object.
Overview
This endpoint allows you to make partial updates to an external account's information - you only have to pass the field(s) you wish to update. This means that end-users will not have to re-enter all fields if they want to update their information.
Updating metadata
- If you do not pass the
metadatafield, the metadata will not be updated in any way - To update an existing metadata key’s value, pass the existing key with the new value along with any existing key-value pair(s)
- To remove metadata, pass any key-values pair you want to maintain, and omit the ones you want to delete. To remove all metadata, pass the metadata key with an empty object
- To add new key-value pair(s), pass any existing metadata key-value pair(s) with the new key(s) and new value(s)
Impact on account verification status
If you are using your own third-party provider for account verification, changing the information on the external account will not re-trigger the account verification process. The external account's status will remain "verified".
If you are using Orum for account verification, changing any information on the external account will re-trigger account verification. You will receive an external_account_unverified webhook and the external account's status will be set to "created" until re-verification is complete.