Skip to main content
POST
Set connection metadata (deprecated)
Requires an API key with the environment:connections:update 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. 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

An Environment API key from your Nango environment.

Body

application/json
connection_id
required

The connection ID used to set the metadata on.

Example:

"connection-123"

provider_config_key
string
required

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

metadata
object
required

Response

Successfully set the metadata for the connections

connection_id

The connection ID used to set the metadata on. Returns an array of connection ids if an array is passed in.

Example:

"connection-123"

provider_config_key
string

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

metadata
object