Connections

Rename a connection

Set a nickname for a connection, so several accounts of the same app are tellable apart ("work gmail" vs "support gmail"). Send an empty string to clear it and fall back to the provider's own label. Only app connections can be renamed; every other family takes its name from a record the provider owns.

patch/connections/{id}

Request

  • Base URL: https://api.crevio.co/v1
  • URL: https://api.crevio.co/v1/connections/{id}
  • Auth: API key in header Authorization

Path parameters

idstring required

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

Request body

nicknamestring required

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

Response

The renamed connection

objectstring required
idstring required
kindstring required
providerstring required
labelstring nullable required
statusstring required
status_detailstring nullable required
disconnectableboolean required
callableboolean required
accessstring required
membersstring[] nullable required
connected_atstring nullable required

Changes

No recorded changes to this operation across all 2 revisions of this API.