PATCH
/
connection
/
metadata
cURL
curl --request PATCH \
  --url https://api.nango.dev/connection/metadata \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "connection_id": "connection-123",
  "provider_config_key": "<string>",
  "metadata": {}
}'
{
  "connection_id": "connection-123",
  "provider_config_key": "<string>",
  "metadata": {}
}

​
Update connection metadata

Nango uses the request body as the new metadata (it must be a JSON object). Note that this overrides specified properties, not the entire metadata. The connection_id must be passed in the body as well. Note that the connection_id can be a single string or an array of strings.

​
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

The secret key from your Nango environment.

Body

application/json

Response

200
application/json

Successfully updated the metadata for the connections

The response is of type object.