> ## Documentation Index
> Fetch the complete documentation index at: https://docs.picaos.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Connection

> Update a Connection

## Path Parameters

<ParamField path="id" type="string" required>
  The connection ID
</ParamField>

## Body Parameters

<ParamField body="tags" type="string[]">
  The connection tags
</ParamField>

## Response

<ResponseField name="id" type="string">
  The unique identifier for the connection
</ResponseField>

<ResponseField name="platformVersion" type="string">
  The version of the platform connector
</ResponseField>

<ResponseField name="name" type="string | null">
  The display name of the connection
</ResponseField>

<ResponseField name="type" type="'api'">
  The connection type
</ResponseField>

<ResponseField name="key" type="string">
  The unique connection key
</ResponseField>

<ResponseField name="environment" type="'test' | 'live'">
  The connection environment
</ResponseField>

<ResponseField name="platform" type="string">
  The platform identifier (e.g. `resend`, `stripe`)
</ResponseField>

<ResponseField name="identity" type="string">
  The user or entity identifier associated with this connection
</ResponseField>

<ResponseField name="identityType" type="'user' | 'team' | 'organization' | 'project'">
  The type of identity
</ResponseField>

<ResponseField name="description" type="string">
  A description of the platform
</ResponseField>

<ResponseField name="state" type="'operational' | 'degraded' | 'failed' | 'unknown'">
  The current state of the connection

  * `operational` - Connection is healthy and working correctly
  * `degraded` - OAuth token refresh failed, automatic retry pending
  * `failed` - Connection is inactive and requires manual reconnection
  * `unknown` - State could not be determined
</ResponseField>

<ResponseField name="tags" type="string[]">
  Array of tags associated with the connection
</ResponseField>

<ResponseField name="version" type="string">
  The connection version
</ResponseField>

<ResponseField name="active" type="boolean">
  Whether the connection is active
</ResponseField>

<ResponseField name="createdAt" type="string">
  ISO 8601 timestamp of when the connection was created
</ResponseField>

<RequestExample>
  ```bash cURL theme={null}
  curl -X PATCH 'https://api.picaos.com/v1/vault/connections/{connection_id}' \
    -H 'Content-Type: application/json' \
    -H 'x-pica-secret: YOUR_API_KEY' \
    -d '{
      "tags": ["new-user", "main"]
    }'
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "id": "673f79c6-0110-408b-bcbe-f4da000e66c7",
    "platformVersion": "1.0.0",
    "name": null,
    "type": "api",
    "key": "test::resend::default::46f75762f34e4962bf5684760f0f9f0e",
    "environment": "test",
    "platform": "resend",
    "identity": "46f75762f34e4962bf5684760f0f9f0e",
    "identityType": "user",
    "description": "Email API for developers",
    "state": "operational",
    "tags": ["new-user", "main"],
    "version": "1.0.0",
    "active": true,
    "createdAt": "2025-07-19T16:19:29.702632Z"
  }
  ```
</ResponseExample>