> For the complete documentation index, see [llms.txt](https://doc.wearepatchworks.com/product-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.wearepatchworks.com/product-documentation/connectors-and-instances/working-with-instances/updating-an-instance.md).

# Updating an instance

## Introduction

You can update an existing connector instance at any time. If you update an instance that is currently used in [process flows](/product-documentation/process-flows/building-process-flows.md), your changes will take effect as soon as the instance is saved.&#x20;

## The steps

To update an existing instance for one of your installed connectors, follow the steps below.

{% stepper %}
{% step %}
**Access your connectors**

Log in to the [Patchworks dashboard](https://app.wearepatchworks.com/login) and select `process flows` ➤ `connectors & instances` to access the `manage connectors` page.
{% endstep %}

{% step %}
**Access settings for the required instance**

Locate the required connector and click the `settings` (i.e. cog) button. For example:

<div align="left"><figure><img src="/files/YSt7nxTGaOILeJRTWM5Y" alt=""><figcaption></figcaption></figure></div>

The `instance settings` page is displayed, with access to configuration options over `instance details`, `authentication`, and `certificates` tabs. For example:

<div align="left"><figure><img src="/files/fHrx5Zk1r8eYjBslUK3t" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
**Review & update settings**

To update basic details for this instance, use the `instance details` tab. To update authentication credentials, click the `authentication` tab, and to update a certificate, use the `certificates` tab.

{% hint style="info" %}
For more information on these options, please refer to [Adding an instance](/product-documentation/connectors-and-instances/working-with-instances/adding-an-instance.md).
{% endhint %}
{% endstep %}

{% step %}
**Test & save**

Having made the required changes, you can use the `test instance connection` button to check authentication credentials are valid, then click `save instance settings` to save your changes.

{% hint style="info" %}
You can't save an instance with invalid authentication credentials.&#x20;

Using the `test instance connection` option before saving allows you to verify credentials without committing your changes. This option is not available for instances where the underlying authentication type is `OAuth 2 (authorisation code)`, or any other authentication type where an extra step is required for the user to verify their credentials. &#x20;
{% endhint %}

{% hint style="info" %}
Changes are retained as you switch between tabs - there's no need to `save instance settings` each time.&#x20;
{% endhint %}
{% endstep %}
{% endstepper %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://doc.wearepatchworks.com/product-documentation/connectors-and-instances/working-with-instances/updating-an-instance.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
