PATCH
/
connection
/
{connectionId}
/
metadata
cURL
curl --request PATCH \
  --url https://api.nango.dev/connection/{connectionId}/metadata \
  --header 'Content-Type: application/json' \
  --header 'Provider-Config-Key: <provider-config-key>' \
  --data '{}'
{}

​
Update connection metadata

Nango uses the request body as the new metadata (it must be a JSON object). Note that this overrides any existing metadata.

​
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.

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 · object

Response

200
application/json

Successfully updated the metadata

The response is of type object.