v63

latestOpenAPI 3.0.0Proprietaryraw.githubusercontent.com2026-08-0110571.8 MB

Connected Accounts

Account Management

Update a connected account

Update a connected account. Supports updating the alias and/or credentials. Only specified fields will be updated. Set a credential field to null to remove it. Alias must be unique within the same project, entity, and toolkit scope.

patch/api/v3.1/connected_accounts/{nanoid}

Path parameters

nanoidstring connectedAccountId required

The unique identifier (nanoid) of the connected account

Request body

aliasstring

A human-readable alias for this connected account. Pass an empty string to clear the alias. Must be unique per entity and toolkit within the project.

Response

Successfully updated connected account

successboolean required

Whether the update was successful

idstring connectedAccountId required

The unique identifier of the updated connected account

statusstring required

The current status of the connected account after the update (ACTIVE, EXPIRED, INACTIVE, etc.)

Example response

{
  "success": true,
  "id": "ca_1a2b3c4d5e6f",
  "status": "ACTIVE"
}