Skip to main content
PATCH
Typescript (SDK)

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Path Parameters

id
string
required

Unified public connection id, as returned by GET /connections/connected. Opaque — pass it back verbatim.

Body

application/json
nickname
string
required

The name to show for this connection. Empty clears it.

Maximum string length: 60

Response

The renamed connection

object
string
required
id
string
required
kind
string
required
provider
string
required
app
string
required
app_name
string | null
required
label
string | null
required
status
enum<string>
required

pending: setup never finished. off: switched off on the account. reconnect_required: its sign-in or key stopped working; connect it again. error: the provider refuses it for a reason reconnecting won't fix (see status_detail). active: usable.

Available options:
pending,
off,
reconnect_required,
error,
active
status_detail
string | null
required

Why it isn't active, in the provider's words, when the provider gives a reason.

disconnectable
boolean
required
callable
boolean
required
access
string
required
members
string[] | null
required
connected_at
string | null
required