update-integration
Update an existing integration. Use this to link an integration to a connector or external app by setting connectorId / externalAppId, or to rename it.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Integration id, uuid, or key to update
Body
Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.
Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.
Display name. Optional on create; used to generate key when key is omitted.
Optional human-readable description.
Optional key-value metadata.
External app id; alternative to connectorId — resolves to the app's default connector.
[INTERNAL] Deprecated: resolved to externalAppId
ID of the connector this integration uses.
Key of the connector; alternative to connectorId. Resolved to connectorId by the API.
Connector-specific parameters (e.g. OAuth { clientId, clientSecret, scopes }).
Response
Update an existing integration. Use this to link an integration to a connector or external app by setting connectorId / externalAppId, or to rename it.
Display name. Always present in API responses (filled by API if not set on create).
Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.
Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.
Optional human-readable description.
Optional key-value metadata.
Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.
BUILDING, CLIENT_ACTION_REQUIRED, CONFIGURATION_ERROR, SETUP_FAILED, READY, DISCONNECTING Validation or setup errors when state is not READY.
Opaque revision token; changes on each update. Used for optimistic concurrency.
ISO date when the element was created.
ISO date when the element was last updated.
When true, the element cannot be modified (e.g. published package elements or elements from another workspace).
Resolved app logo for this element (integration -> connector -> external app -> favicon).
[INTERNAL] Deprecated: Use externalAppId instead
integration-app-token, membrane-token, oauth2, oauth1, client-credentials, proxy Marks integrations derived from workspace-owned, non-public connectors or external apps.