POST
/
connection
/
{connectionId}
/
metadata
Header
Path
Body
curl --request POST \
  --url https://api.nango.dev/connection/{connectionId}/metadata \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Provider-Config-Key: <provider-config-key>'
This response has no body data.

​
Update connection metadata

Use this API endpoint to update your custom metadata for a connection.

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 it. Your custom metadata is included as part of the returned connection object.

Headers

Provider-Config-Keyrequired
string

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

Path Parameters

connectionIdrequired
string

The connection ID used to create the connection.

Body

application/json · object

The body is of type object.

Response

201
Import a connectionDelete a connection