Skip to main content
POST
/
connection
/
{connectionId}
/
metadata
Set connection metadata (deprecated)
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>' \
  --data '{}'
{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "errors": [
      {}
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://nango.dev/docs/llms.txt

Use this file to discover all available pages before exploring further.

Requires an API key with the environment:connections:write scope. Learn more about API key scopes.

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

Authorizations

​
Authorization
string
header
required

The secret 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 created an integrations