PATCH
/
connection
/
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.

Body

application/json
connection_id
required

The connection ID used to update the metadata on. Accepts an array of connection ids as well

provider_config_key
string
required

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

metadata
object
required

Response

200 - application/json
connection_id

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

provider_config_key
string

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

metadata
object