Skip to main content
PATCH
Edit connection metadata (deprecated)
Requires an API key with the environment:connections:update scope. Learn more about API key scopes.

Update connection metadata

Nango uses the request body as the new metadata (it must be a JSON object).

Fetching connection metadata

To read the existing metadata of a connection, simply fetch the connection. Your custom metadata is included as part of the returned connection object.

Authorizations

Authorization
string
header
required

An Environment API key from your Nango environment.

Headers

Provider-Config-Key
string
required

The integration ID used to create the connection (aka Unique Key).

Path Parameters

connectionId
string
required

The connection ID used to create the connection.

Body

application/json

The body is of type object.

Response

Successfully updated the metadata

The response is of type object.