Skip to main content
PATCH

Authorizations

x-api-key
string
header
default:your-project-api-key
required

Your Composio project API key. Create or copy it from the Composio dashboard.

Path Parameters

nanoid
string<connectedAccountId>
required

The unique identifier (nanoid) of the connected account

Body

application/json
alias
string

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.

Maximum string length: 255
connection
object
experimental
object

Experimental features - not stable, may be modified or removed in future versions.

Response

Successfully updated connected account

success
boolean
required

Whether the update was successful

id
string<connectedAccountId>
required

The unique identifier of the updated connected account

status
string
required

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