Skip to main content
PATCH
https://api.picaos.com
/
v1
/
vault
/
connections
/
{id}
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"]
  }'
{
  "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"
}

Path Parameters

id
string
required
The connection ID

Body Parameters

tags
string[]
The connection tags

Response

id
string
The unique identifier for the connection
platformVersion
string
The version of the platform connector
name
string | null
The display name of the connection
type
'api'
The connection type
key
string
The unique connection key
environment
'test' | 'live'
The connection environment
platform
string
The platform identifier (e.g. resend, stripe)
identity
string
The user or entity identifier associated with this connection
identityType
'user' | 'team' | 'organization' | 'project'
The type of identity
description
string
A description of the platform
state
'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
tags
string[]
Array of tags associated with the connection
version
string
The connection version
active
boolean
Whether the connection is active
createdAt
string
ISO 8601 timestamp of when the connection was created
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"]
  }'
{
  "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"
}