Skip to main content
PATCH
/
integrations
/
{id}
Update integration partially
curl --request PATCH \
  --url https://api.getmembrane.com/integrations/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "uuid": "<string>",
  "key": "<string>",
  "name": "<string>",
  "description": "<string>",
  "meta": {},
  "logoUri": "<string>",
  "externalAppId": "<string>",
  "externalAppUuid": "<string>",
  "oAuthCallbackUri": "<string>",
  "logoBase64": "<string>",
  "connectorVersion": "<string>",
  "connectorId": "<string>",
  "connectorUuid": "<string>",
  "connectorKey": "<string>",
  "parameters": {},
  "optionsConfig": {}
}
'
{
  "name": "<string>",
  "id": "<string>",
  "uuid": "<string>",
  "key": "<string>",
  "description": "<string>",
  "meta": {},
  "errors": [
    {
      "message": "<string>",
      "key": "<string>",
      "data": {},
      "stack": {},
      "causedByError": "<unknown>",
      "logs": [
        {}
      ]
    }
  ],
  "revision": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "archivedAt": "<string>",
  "isDeactivated": true,
  "isReadOnly": true,
  "logoUri": "<string>",
  "connectorId": "<string>",
  "connectorVersion": "<string>",
  "oAuthCallbackUri": "<string>",
  "parameters": {},
  "hasMissingParameters": true,
  "hasDocumentation": true,
  "hasOperations": true,
  "operationsCount": 123,
  "hasData": true,
  "dataCollectionsCount": 123,
  "hasEvents": true,
  "eventsCount": 123,
  "hasGlobalWebhooks": true,
  "hasUdm": true,
  "isTest": true,
  "externalAppId": "<string>",
  "optionsConfig": {},
  "connection": {
    "id": "<string>",
    "name": "<string>",
    "userId": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "tenantId": "<string>",
    "key": "<string>",
    "isTest": true,
    "connected": true,
    "disconnected": true,
    "isDefunct": true,
    "errors": [
      {
        "message": "<string>",
        "key": "<string>",
        "data": {},
        "stack": {},
        "causedByError": "<unknown>",
        "logs": [
          {}
        ]
      }
    ],
    "requestError": {
      "message": "<string>",
      "key": "<string>",
      "data": {},
      "stack": {},
      "causedByError": "<unknown>",
      "logs": [
        {}
      ]
    },
    "error": {
      "message": "<string>",
      "key": "<string>",
      "data": {},
      "stack": {},
      "causedByError": "<unknown>",
      "logs": [
        {}
      ]
    },
    "integrationId": "<string>",
    "connectorId": "<string>",
    "externalAppId": "<string>",
    "connectorVersion": "<string>",
    "authOptionKey": "<string>",
    "lastActiveAt": "<string>",
    "nextCredentialsRefreshAt": "<string>",
    "nextRetryTimestamp": "<string>",
    "retryAttempts": 123,
    "canTest": true,
    "canRefreshCredentials": true,
    "archivedAt": "<string>",
    "isDeactivated": true,
    "meta": {},
    "buildingAgentSessionId": "<string>",
    "clientAction": {
      "description": "<string>",
      "uiUrl": "<string>",
      "agentInstructions": "<string>"
    }
  },
  "spec": {},
  "appUri": "<string>",
  "isConnected": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.getmembrane.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Body

application/json
​
uuid
string

Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.

​
key
string

Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.

​
name
string

Display name. Optional on create; used to generate key when key is omitted.

​
description
string

Optional human-readable description.

​
meta
object

Optional key-value metadata.

​
logoUri
string
​
externalAppId
string

External app id; alternative to connectorId — resolves to the app's default connector.

​
externalAppUuid
string
​
oAuthCallbackUri
​
logoBase64
string
​
connectorVersion
string
​
connectorId
string

ID of the connector this integration uses.

​
connectorUuid
string
​
connectorKey
string

Key of the connector; alternative to connectorId. Resolved to connectorId by the API.

​
parameters
object

Connector-specific parameters (e.g. OAuth { clientId, clientSecret, scopes }).

​
optionsConfig
object

Response

200 - application/json
​
name
string
required

Display name. Always present in API responses (filled by API if not set on create).

​
id
string
​
uuid
string

Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.

​
key
string

Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.

​
description
string

Optional human-readable description.

​
meta
object

Optional key-value metadata.

​
state
enum<string>

Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.

Available options:
BUILDING,
CLIENT_ACTION_REQUIRED,
CONFIGURATION_ERROR,
SETUP_FAILED,
READY,
DISCONNECTING
​
errors
object[]

Validation or setup errors when state is not READY.

​
revision
string

Opaque revision token; changes on each update. Used for optimistic concurrency.

​
createdAt
string

ISO date when the element was created.

​
updatedAt
string

ISO date when the element was last updated.

​
archivedAt
string
​
isDeactivated
boolean
​
isReadOnly
boolean

When true, the element cannot be modified (e.g. published package elements or elements from another workspace).

​
logoUri
string
​
connectorId
string
​
connectorVersion
string
​
oAuthCallbackUri
string
​
parameters
object
​
hasMissingParameters
boolean
​
hasDocumentation
boolean
​
hasOperations
boolean
​
operationsCount
number
​
hasData
boolean
​
dataCollectionsCount
number
​
hasEvents
boolean
​
eventsCount
number
​
hasGlobalWebhooks
boolean
​
hasUdm
boolean
​
isTest
boolean
​
externalAppId
string
​
authType
enum<string>
Available options:
integration-app-token,
membrane-token,
oauth2,
oauth1,
client-credentials,
proxy
​
optionsConfig
object
​
connection
object
​
spec
object
​
appUri
string
​
isConnected
boolean