Skip to main content
PATCH
Edit a connection
Requires an API key with the environment:connections:update scope. Learn more about API key scopes.

Authorizations

Authorization
string
header
required

An Environment API key from your Nango environment, or an Account API key for account-level endpoints.

Path Parameters

connectionId
string
required

The connection ID used to create the connection.

Query Parameters

provider_config_key
string
required

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

Body

application/json
tags
object

Connection tags (key/value strings). Keys are normalized to lowercase.

webhook_url_override
string

Override the environment's webhook URLs for this connection. When set, this connection's webhooks are sent only to this URL. Pass an empty string to clear the override.

end_user
object
deprecated

Deprecated, use tags instead

Response

Successfully updated the connection

success
boolean