> ## Documentation Index > Fetch the complete documentation index at: https://docs.membrane.agency/llms.txt > Use this file to discover all available pages before exploring further. # update-connector > Update an existing connector by id or key. Pass only the fields you want to change — they are merged with existing config. ## OpenAPI ````yaml /api-reference/membrane-api.json patch /connectors/{idOrKey} openapi: 3.0.0 info: title: Membrane API description: API documentation for Membrane Engine version: '1.0' contact: {} servers: - url: https://api.getmembrane.com security: - bearer: [] tags: [] paths: /connectors/{idOrKey}: patch: summary: update-connector description: >- Update an existing connector by id or key. Pass only the fields you want to change — they are merged with existing config. operationId: updateConnector parameters: - name: idOrKey in: path required: true schema: type: string description: Connector id, uuid, or key to update requestBody: required: false content: application/json: schema: type: object properties: key: type: string name: type: string logoUri: type: string externalAppId: type: string externalAppUuid: type: string appUuid: description: '[INTERNAL] Deprecated: resolved to externalAppId' type: string categories: type: array items: type: string authOptions: description: >- [INTERNAL] Agent alias: an array of auth options, normalized server-side into the canonical single-auth top-level fields (one option) or the `options` record (multiple). Public callers use `options` directly; do not advertise this field. type: description: Authentication protocol used by the connector. type: string enum: - integration-app-token - membrane-token - oauth2 - oauth1 - client-credentials - proxy customCredentialsSchema: description: >- Additional JSON Schema for workspace-level overrides of credentials (e.g. BYO-OAuth clientId/clientSecret). allOf: - type: object inputSchema: description: >- JSON Schema for end-user input collected during connection (e.g. an API key or subdomain the user types in). allOf: - type: object parametersSchema: allOf: - type: object getCredentialsFromConnectionParameters: description: >- Function that derives auth credentials from connection parameters. Use for static-key auth (api-key, basic-auth) where the user-provided input IS the credential. type: object properties: type: type: string enum: - mapping - rest-api-mapping - graphql-api-mapping - javascript description: description: >- Human-readable summary of what this function does, in plain language. Shown in the UI by default in place of the code. Populate it whenever you author or change the code. type: string additionalProperties: {} refreshCredentials: description: >- Function that refreshes expired credentials. Implement for non-standard OAuth refresh flows or when additional credentials need to be refreshed alongside the OAuth token. type: object properties: type: type: string enum: - mapping - rest-api-mapping - graphql-api-mapping - javascript description: description: >- Human-readable summary of what this function does, in plain language. Shown in the UI by default in place of the code. Populate it whenever you author or change the code. type: string additionalProperties: {} makeApiClient: description: >- Function that configures the authenticated HTTP client used by connector API requests and actions. Typically a `mapping` type with `baseUri` and auth header wiring. type: object properties: type: type: string enum: - mapping - rest-api-mapping - graphql-api-mapping - javascript description: description: >- Human-readable summary of what this function does, in plain language. Shown in the UI by default in place of the code. Populate it whenever you author or change the code. type: string additionalProperties: {} getOAuthConfig: description: >- OAuth2: function returning `{ authorizeUri, tokenUri, scopes, noRefreshToken? }` — the authorize/token endpoint URLs and requested scopes. type: object properties: type: type: string enum: - mapping - rest-api-mapping - graphql-api-mapping - javascript description: description: >- Human-readable summary of what this function does, in plain language. Shown in the UI by default in place of the code. Populate it whenever you author or change the code. type: string additionalProperties: {} getTokenData: description: >- OAuth2: function invoked with the raw token response to extract token metadata. Rarely needed. type: object properties: type: type: string enum: - mapping - rest-api-mapping - graphql-api-mapping - javascript description: description: >- Human-readable summary of what this function does, in plain language. Shown in the UI by default in place of the code. Populate it whenever you author or change the code. type: string additionalProperties: {} getCredentialsFromAccessTokenResponse: description: >- OAuth2: function that transforms the token endpoint response into the final credentials object. Required for multi-tenant APIs (Microsoft) or APIs that require post-OAuth bootstrap calls. type: object properties: type: type: string enum: - mapping - rest-api-mapping - graphql-api-mapping - javascript description: description: >- Human-readable summary of what this function does, in plain language. Shown in the UI by default in place of the code. Populate it whenever you author or change the code. type: string additionalProperties: {} getCredentialsFromRefreshTokenResponse: description: >- OAuth2: function that transforms the refresh token endpoint response into the refreshed credentials. Required when refresh responses differ from initial-token responses. type: object properties: type: type: string enum: - mapping - rest-api-mapping - graphql-api-mapping - javascript description: description: >- Human-readable summary of what this function does, in plain language. Shown in the UI by default in place of the code. Populate it whenever you author or change the code. type: string additionalProperties: {} test: description: >- Function that verifies the connection by making a lightweight authenticated API call (typically a `rest-api-mapping` against a `/me`-style endpoint). type: object properties: type: type: string enum: - mapping - rest-api-mapping - graphql-api-mapping - javascript description: description: >- Human-readable summary of what this function does, in plain language. Shown in the UI by default in place of the code. Populate it whenever you author or change the code. type: string additionalProperties: {} disconnect: description: >- Function that revokes credentials at the provider when the connection is removed. Implement only if the provider exposes a revoke endpoint. type: object properties: type: type: string enum: - mapping - rest-api-mapping - graphql-api-mapping - javascript description: description: >- Human-readable summary of what this function does, in plain language. Shown in the UI by default in place of the code. Populate it whenever you author or change the code. type: string additionalProperties: {} proxyKey: description: >- For `type: "proxy"` — identifies which proxy configuration the workspace should use. type: string ui: description: '[INTERNAL] Deprecated: Use inputSchema instead' type: object properties: schema: allOf: - type: object description: type: string helpUri: type: string additionalProperties: false options: description: >- Map of auth option key to auth configuration, for connectors that support multiple auth methods. Mutually exclusive with the top-level auth fields: use either the top-level fields (single-auth) OR `options` (multi-auth), not both. type: object additionalProperties: type: object properties: type: description: Authentication protocol used by the connector. type: string enum: - integration-app-token - membrane-token - oauth2 - oauth1 - client-credentials - proxy customCredentialsSchema: description: >- Additional JSON Schema for workspace-level overrides of credentials (e.g. BYO-OAuth clientId/clientSecret). allOf: - type: object inputSchema: description: >- JSON Schema for end-user input collected during connection (e.g. an API key or subdomain the user types in). allOf: - type: object parametersSchema: description: >- JSON Schema for connector-level parameters configured per integration (e.g. region, account ID). allOf: - type: object getCredentialsFromConnectionParameters: description: >- Function that derives auth credentials from connection parameters. Use for static-key auth (api-key, basic-auth) where the user-provided input IS the credential. type: object properties: type: type: string enum: - mapping - rest-api-mapping - graphql-api-mapping - javascript description: description: >- Human-readable summary of what this function does, in plain language. Shown in the UI by default in place of the code. Populate it whenever you author or change the code. type: string additionalProperties: {} refreshCredentials: description: >- Function that refreshes expired credentials. Implement for non-standard OAuth refresh flows or when additional credentials need to be refreshed alongside the OAuth token. type: object properties: type: type: string enum: - mapping - rest-api-mapping - graphql-api-mapping - javascript description: description: >- Human-readable summary of what this function does, in plain language. Shown in the UI by default in place of the code. Populate it whenever you author or change the code. type: string additionalProperties: {} makeApiClient: description: >- Function that configures the authenticated HTTP client used by connector API requests and actions. Typically a `mapping` type with `baseUri` and auth header wiring. type: object properties: type: type: string enum: - mapping - rest-api-mapping - graphql-api-mapping - javascript description: description: >- Human-readable summary of what this function does, in plain language. Shown in the UI by default in place of the code. Populate it whenever you author or change the code. type: string additionalProperties: {} getOAuthConfig: description: >- OAuth2: function returning `{ authorizeUri, tokenUri, scopes, noRefreshToken? }` — the authorize/token endpoint URLs and requested scopes. type: object properties: type: type: string enum: - mapping - rest-api-mapping - graphql-api-mapping - javascript description: description: >- Human-readable summary of what this function does, in plain language. Shown in the UI by default in place of the code. Populate it whenever you author or change the code. type: string additionalProperties: {} getTokenData: description: >- OAuth2: function invoked with the raw token response to extract token metadata. Rarely needed. type: object properties: type: type: string enum: - mapping - rest-api-mapping - graphql-api-mapping - javascript description: description: >- Human-readable summary of what this function does, in plain language. Shown in the UI by default in place of the code. Populate it whenever you author or change the code. type: string additionalProperties: {} getCredentialsFromAccessTokenResponse: description: >- OAuth2: function that transforms the token endpoint response into the final credentials object. Required for multi-tenant APIs (Microsoft) or APIs that require post-OAuth bootstrap calls. type: object properties: type: type: string enum: - mapping - rest-api-mapping - graphql-api-mapping - javascript description: description: >- Human-readable summary of what this function does, in plain language. Shown in the UI by default in place of the code. Populate it whenever you author or change the code. type: string additionalProperties: {} getCredentialsFromRefreshTokenResponse: description: >- OAuth2: function that transforms the refresh token endpoint response into the refreshed credentials. Required when refresh responses differ from initial-token responses. type: object properties: type: type: string enum: - mapping - rest-api-mapping - graphql-api-mapping - javascript description: description: >- Human-readable summary of what this function does, in plain language. Shown in the UI by default in place of the code. Populate it whenever you author or change the code. type: string additionalProperties: {} test: description: >- Function that verifies the connection by making a lightweight authenticated API call (typically a `rest-api-mapping` against a `/me`-style endpoint). type: object properties: type: type: string enum: - mapping - rest-api-mapping - graphql-api-mapping - javascript description: description: >- Human-readable summary of what this function does, in plain language. Shown in the UI by default in place of the code. Populate it whenever you author or change the code. type: string additionalProperties: {} disconnect: description: >- Function that revokes credentials at the provider when the connection is removed. Implement only if the provider exposes a revoke endpoint. type: object properties: type: type: string enum: - mapping - rest-api-mapping - graphql-api-mapping - javascript description: description: >- Human-readable summary of what this function does, in plain language. Shown in the UI by default in place of the code. Populate it whenever you author or change the code. type: string additionalProperties: {} proxyKey: description: >- For `type: "proxy"` — identifies which proxy configuration the workspace should use. type: string ui: description: '[INTERNAL] Deprecated: Use inputSchema instead' type: object properties: schema: allOf: - type: object description: type: string helpUri: type: string additionalProperties: false title: type: string description: type: string enabled: {} additionalProperties: false additionalProperties: false responses: '200': description: >- Update an existing connector by id or key. Pass only the fields you want to change — they are merged with existing config. content: application/json: schema: type: object properties: id: type: string key: type: string name: type: string isReadOnly: type: boolean additionalProperties: {} components: securitySchemes: bearer: scheme: bearer bearerFormat: JWT type: http ````