Skip to main content
PATCH
Rename a connection

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
external_id
string | null
required
label
string | null
required
status
string
required
status_detail
string | null
required
disconnectable
boolean
required
callable
boolean
required
connected_at
string | null
required