Connections
Edit connection metadata
Edit custom metadata for the connection (only overrides specified properties, not the entire metadata).
PATCH
/
connection
/
{connectionId}
/
metadata
Update 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.
Headers
Provider-Config-Key
string
requiredThe integration ID used to create the connection (aka Unique Key).
Path Parameters
connectionId
string
requiredThe connection ID used to create the connection.
Body
application/json · object
The body is of type object
.
Response
200 - application/json
The response is of type object
.
Was this page helpful?