Update Connector
Audience:
Low-code EngineersSkill Prerequisites:
Actions,Tokens,JSON,Connectors
Changes the properties of an existing connector of any type. You pick the connector and set only the properties you want to change. The other properties keep their current values, and the connector keeps its ID and name, so the actions that use it keep working.
This action is part of the Advanced Security feature (Enterprise). If your plan doesn't include it, the action editor shows the action as not part of your subscription.
Typical Use Cases
- Replace an API key or password that has expired or was rotated
- Point a Database Connection connector to a new server
- Let users update their own connector details from a form
Don't use it to
- Create a connector. Use Add Connector instead.
- Rename a connector. The name stays the same. Change it on the Connectors page.
- Check that the new details work. Use Test Connector after updating.
Related Actions
| Action Name | Description |
|---|---|
| Add Connector | Creates a new connector. |
| Test Connector | Checks that a connector can connect to its service. |
| Get Connector | Reads the details of a connector into tokens. |
| Delete Connector | Removes a connector. |
Input Parameter Reference
| Parameter | Description | Supports Tokens | Default | Required |
|---|---|---|---|---|
| Connector | The connector to update. The list shows all connectors. When using an expression, the value must be the connector ID (a GUID), for example [DbConnectorId]. | Yes | empty string | Yes |
| Properties | The properties to change, as Name and Value pairs. The Name list shows the properties of the selected connector's type. Values can contain tokens. | Yes | empty | No |
| Dynamic Properties | A JSON object with property names and values, for example { "ApiKey": "[NewApiKey]" }. Properties in this object override the same properties in Properties. | Yes | empty string | No |
How properties are combined
The action first combines Properties and Dynamic Properties. If a property is in both, the value from Dynamic Properties wins. Then it applies the result on top of the connector's current values:
| Property | Result |
|---|---|
| Set in the action | Gets the new value |
| Not set in the action | Keeps its current value |
Secure property set to ****** | Keeps its current value |
Only properties that belong to the connector's type are changed. Other names are ignored without an error. Names must match the property IDs of the type exactly, including upper and lower case.
Considerations
- The connector must exist. If no connector has that ID, the action fails with
Connector not found.If its type is no longer installed, it fails withConnector type '<type>' is not defined. - Required properties can't be emptied. Setting a required property to an empty value fails the action with
Parameter '<property title>' is required. - Custom data is removed. For connector types that support custom data, such as Salesforce, updating the connector with this action deletes its custom data. Use the type-specific update action, such as Update Salesforce Connector, for those connectors.
- The details aren't tested. Run Test Connector to check them.
- Keep secrets out of the action. Pass new keys and passwords through tokens instead of typing them into the action.
- Invalid JSON fails the action. Check that
Dynamic Propertiesis a valid JSON object when you build it with tokens.
Examples
To understand how to use the below examples, please see Running Examples.
1. Replace a database connection string
This action updates the connector whose ID is in [DbConnectorId] with a new connection string from a form field.
{
"Title": "Update Connector",
"ActionType": "Connectors.Update",
"Description": "Point the reporting connector to the new server",
"Parameters": {
"EntryId": "[DbConnectorId]",
"Properties": [
{
"PropertyName": "ConnectionString",
"PropertyValue": "[NewConnectionString]"
}
],
"PropertiesJson": ""
}
}
2. Rotate an API key with Dynamic Properties
This action sets a new API key on an OpenAI connector. It runs only when the NewApiKey token has a value.
{
"Title": "Update Connector",
"ActionType": "Connectors.Update",
"Description": "Rotate the OpenAI key",
"Condition": "[NewApiKey] != \"\"",
"Parameters": {
"EntryId": "[OpenAiConnectorId]",
"Properties": [],
"PropertiesJson": "{ \"ApiKey\": \"[NewApiKey]\" }"
}
}
Revised 09/26/2026