Connected Accounts

Update a connected account

Changed on

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}

Request

  • Base URL
    https://backend.composio.dev
  • URL
    https://backend.composio.dev/api/v3.1/connected_accounts/{nanoid}
  • Auth
    API key in header x-api-key

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"
}

Changes

  • 98956f31abf3Revision changes
    • info

      api operation id patchV3_1ConnectedAccountsByNanoid removed and replaced with patchConnectedAccountsByNanoid

    • info

      api tag Account Management removed

    • info

      added the non-success response with the status

  • 589a7d115a5eRevision changes
    • info

      the endpoint scheme security CookieAuth was removed from the API

    • info

      the endpoint scheme security UserApiKeyAuth was removed from the API