Update Link
Update Link
Updates the link configuration.
URL
Request
Response
link_tags
: array
Arbitrary strings used to describe this link.
example: smoke_test
example: user_type:admin
webhook
: string
Sets the webhook URL for this link.
To remove a webhook for this link, set to null
.
format:
uri
min length:
1
max length:
65536
example: https://example.com/updated/hook
id
: string
required
The unique ID for this link.
example: mk_eqkWN34UEoa2NxyALG8pcV
Responses
200
Updated link.
link_id
: string
The unique ID for this link.
example: mk_eqkWN34UEoa2NxyALG8pcV
institution_id
: string
The unique ID for the institution this link is connected to.
example: chase
institution_name
: string
The institution name this link is connected to.
example: Chase
institution_avatar
: string
An avatar image for the link's institution.
example: https://example.com/avatar.png
state
: string
An enumeration.
connecting
awaiting_token_exchange
connected
deleted
error
example: connected
Allowed values:
"connecting"
"awaiting_token_exchange"
"connected"
"deleted"
"error"
error_code
: string
An enumeration.
system_error
provider_error
institution_error
user_error
auth_expired
incomplete
no_accounts
user_setup_required
invalid_credentials
user_oauth_denied
user_input_incorrect
Allowed values:
"system_error"
"provider_error"
"institution_error"
"user_error"
"auth_expired"
"incomplete"
"no_accounts"
"user_setup_required"
"invalid_credentials"
"user_oauth_denied"
"user_input_incorrect"
last_synced_at
: string
deprecated
(Deprecated) An ISO-8601 timestamp indicating the last time that the link was updated.
format:
date-time
example: 2023-02-16T09:14:11
provider
: string
An enumeration.
moneykit
finicity
plaid
yodlee
mx
akoya
example: mx
Allowed values:
"moneykit"
"finicity"
"plaid"
"yodlee"
"mx"
"akoya"
link_tags
: array
Arbitrary strings used to describe this link.
example: smoke_test
example: user_type:admin
tags
: array
deprecated
DEPRECATED; use link_tags
instead
webhook
: string
The webhook url assigned to this link.
example: https://example.com/webhook
products
: object
The granted products available for this link.
available_products
: array
A list of products that could be added to this link.
Products can be added to (and removed from) an existing link by creating a new /link-session
and supplying the existing_link_id
with a new set of products.
example: account_numbers
Allowed values:
"accounts"
"account_numbers"
"identity"
"transactions"
"investments"
"enrichment"
403
Forbidden by link owner. The user did not give permission to access this data when linking.
error_code
: string
link_error.forbidden_action
default: "link_error.forbidden_action"
Allowed values:
"link_error.forbidden_action"
error_message
: string
Error message
example: Accounts access not permitted
documentation_url
: string
404
Link not found.
error_code
: string
link_error.not_found
default: "link_error.not_found"
Allowed values:
"link_error.not_found"
error_message
: string
default: "Link not found."
documentation_url
: string
410
Link deleted.
error_code
: string
link_error.deleted
default: "link_error.deleted"
Allowed values:
"link_error.deleted"
error_message
: string
default: "This link was deleted at some earlier time."
documentation_url
: string
422
Link error.
error_code
: string
link_error.bad_state
default: "link_error.bad_state"
Allowed values:
"link_error.bad_state"
error_message
: string
documentation_url
: string
link_error_code
: string
429
Rate limit exceeded.
error_code
: string
api_error.rate_limit_exceeded
default: "api_error.rate_limit_exceeded"
Allowed values:
"api_error.rate_limit_exceeded"
error_message
: string
Error message
default: "Rate limit exceeded"
documentation_url
: string