Update connected account credentials
Replace the API credentials (secret + API key) of a connected account.
Credentials belong to an API key, which can back a single account or an entire hierarchy. Updating them affects all accounts sharing that key, so the endpoint returns an array of modified accounts.
The creds field must be a Base64-encoded RSA-encrypted credential blob; use
GET /connected_accounts/credentials/public_key to retrieve the public key for encryption.
Both creds and apiKey are mandatory.
Validation against the exchange is synchronous, but the update itself is pending mobile approval — the existing credentials stay live until the change is approved, so none of the affected accounts are disconnected in the meantime.
Endpoint Permission: Admin, Non-Signing Admin.
Note: This endpoint is currently in beta and might be subject to changes.
Headers
A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.
Path Parameters
The unique identifier of the connected account whose API key credentials are being replaced.
1Body
Base64-encoded RSA-encrypted credential blob (the new secret). Encrypt using the public key from GET /connected_accounts/credentials/public_key.
"base64encodedencryptedcredentials=="
The new account-level API key. Mandatory for credential update.
"api_key_new_abc123"
Response
Credential update initiated (pending approval).
The account whose credentials are pending update (status WAITING_FOR_APPROVAL). Old credentials stay live until the change is approved.