Skip to main content
PATCH
Update source
A source has at most one ledger account. The response returns it in detail.ledger_account_id. The organization, credentials and import identity of a source cannot be changed.

Authorizations

X-API-Key
string
header
required

Your organization API key. Some operations also need a key that is associated with a user; their pages say so.

Path Parameters

source_id
string
required

ID of the source.

Minimum string length: 1

Body

application/json

Provide at least one field. Omit a field to leave it unchanged.

name
string

Rename wallet, exchange, Plaid, or manual-bank sources. Other source types do not support renaming. An unsupported field returns 422 without applying the update.

status
enum<string>

Source status. Supported by wallet, exchange, Plaid and manual-bank sources. Other source types have no status and return HTTP 422.

Available options:
active,
archived

Prefixed le_ id, or null to clear.

ledger_account_id
string | null

Ledger account (lac_…). Send null to clear it; omit to keep it. Niural sources return HTTP 422.

tag_ids
string[] | null

Replaces the tags (tag_…). [] clears them; omit to keep them. You cannot send it with add_tag_ids or remove_tag_ids. Wallet, exchange, Plaid and manual-bank sources only; other sources return HTTP 422.

add_tag_ids
string[]

Tags to add (tag_…). Wallet, exchange, Plaid and manual-bank sources only; other sources return HTTP 422.

remove_tag_ids
string[]

Tags to remove (tag_…). Wallet, exchange, Plaid and manual-bank sources only; other sources return HTTP 422.

allow_nft_import
boolean

Enable or disable NFT import for a wallet. Other source types do not support this field. An unsupported field returns 422 without applying the update.

group_id
string | null

Prefixed sgp_ id of a source group, or null to remove the source from its group.

Response

The request succeeded.

data
object
required