Update connection completely
curl --request PUT \
--url https://api.getmembrane.com/connections/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"meta": {},
"authOptionKey": "<string>",
"key": "<string>",
"integrationId": "<string>",
"integrationUuid": "<string>",
"integrationKey": "<string>",
"connectorId": "<string>",
"connectorUuid": "<string>",
"connectorKey": "<string>",
"connectorVersion": "<string>",
"externalAppId": "<string>",
"externalAppUuid": "<string>",
"credentials": {},
"connectorParameters": {},
"input": {},
"intent": "<string>"
}
'import requests
url = "https://api.getmembrane.com/connections/{id}"
payload = {
"name": "<string>",
"meta": {},
"authOptionKey": "<string>",
"key": "<string>",
"integrationId": "<string>",
"integrationUuid": "<string>",
"integrationKey": "<string>",
"connectorId": "<string>",
"connectorUuid": "<string>",
"connectorKey": "<string>",
"connectorVersion": "<string>",
"externalAppId": "<string>",
"externalAppUuid": "<string>",
"credentials": {},
"connectorParameters": {},
"input": {},
"intent": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
meta: {},
authOptionKey: '<string>',
key: '<string>',
integrationId: '<string>',
integrationUuid: '<string>',
integrationKey: '<string>',
connectorId: '<string>',
connectorUuid: '<string>',
connectorKey: '<string>',
connectorVersion: '<string>',
externalAppId: '<string>',
externalAppUuid: '<string>',
credentials: {},
connectorParameters: {},
input: {},
intent: '<string>'
})
};
fetch('https://api.getmembrane.com/connections/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getmembrane.com/connections/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'meta' => [
],
'authOptionKey' => '<string>',
'key' => '<string>',
'integrationId' => '<string>',
'integrationUuid' => '<string>',
'integrationKey' => '<string>',
'connectorId' => '<string>',
'connectorUuid' => '<string>',
'connectorKey' => '<string>',
'connectorVersion' => '<string>',
'externalAppId' => '<string>',
'externalAppUuid' => '<string>',
'credentials' => [
],
'connectorParameters' => [
],
'input' => [
],
'intent' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.getmembrane.com/connections/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"meta\": {},\n \"authOptionKey\": \"<string>\",\n \"key\": \"<string>\",\n \"integrationId\": \"<string>\",\n \"integrationUuid\": \"<string>\",\n \"integrationKey\": \"<string>\",\n \"connectorId\": \"<string>\",\n \"connectorUuid\": \"<string>\",\n \"connectorKey\": \"<string>\",\n \"connectorVersion\": \"<string>\",\n \"externalAppId\": \"<string>\",\n \"externalAppUuid\": \"<string>\",\n \"credentials\": {},\n \"connectorParameters\": {},\n \"input\": {},\n \"intent\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.getmembrane.com/connections/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"meta\": {},\n \"authOptionKey\": \"<string>\",\n \"key\": \"<string>\",\n \"integrationId\": \"<string>\",\n \"integrationUuid\": \"<string>\",\n \"integrationKey\": \"<string>\",\n \"connectorId\": \"<string>\",\n \"connectorUuid\": \"<string>\",\n \"connectorKey\": \"<string>\",\n \"connectorVersion\": \"<string>\",\n \"externalAppId\": \"<string>\",\n \"externalAppUuid\": \"<string>\",\n \"credentials\": {},\n \"connectorParameters\": {},\n \"input\": {},\n \"intent\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getmembrane.com/connections/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"meta\": {},\n \"authOptionKey\": \"<string>\",\n \"key\": \"<string>\",\n \"integrationId\": \"<string>\",\n \"integrationUuid\": \"<string>\",\n \"integrationKey\": \"<string>\",\n \"connectorId\": \"<string>\",\n \"connectorUuid\": \"<string>\",\n \"connectorKey\": \"<string>\",\n \"connectorVersion\": \"<string>\",\n \"externalAppId\": \"<string>\",\n \"externalAppUuid\": \"<string>\",\n \"credentials\": {},\n \"connectorParameters\": {},\n \"input\": {},\n \"intent\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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>",
"handoffAgentInstructions": "<string>"
},
"user": {
"id": "<string>",
"name": "<string>",
"internalId": "<string>",
"meta": {},
"fields": {},
"credentials": {},
"lastActiveAt": "<string>",
"isTest": true,
"isBillable": true,
"isActive": true,
"aiCreditsRolling30DayLimit": 1,
"createdAt": "<string>",
"archivedAt": "<string>"
},
"integration": {
"id": "<string>",
"name": "<string>",
"logoUri": "<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,
"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": {}
},
"connectorParameters": {},
"input": {}
}Connections
Update connection completely
PUT
/
connections
/
{id}
Update connection completely
curl --request PUT \
--url https://api.getmembrane.com/connections/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"meta": {},
"authOptionKey": "<string>",
"key": "<string>",
"integrationId": "<string>",
"integrationUuid": "<string>",
"integrationKey": "<string>",
"connectorId": "<string>",
"connectorUuid": "<string>",
"connectorKey": "<string>",
"connectorVersion": "<string>",
"externalAppId": "<string>",
"externalAppUuid": "<string>",
"credentials": {},
"connectorParameters": {},
"input": {},
"intent": "<string>"
}
'import requests
url = "https://api.getmembrane.com/connections/{id}"
payload = {
"name": "<string>",
"meta": {},
"authOptionKey": "<string>",
"key": "<string>",
"integrationId": "<string>",
"integrationUuid": "<string>",
"integrationKey": "<string>",
"connectorId": "<string>",
"connectorUuid": "<string>",
"connectorKey": "<string>",
"connectorVersion": "<string>",
"externalAppId": "<string>",
"externalAppUuid": "<string>",
"credentials": {},
"connectorParameters": {},
"input": {},
"intent": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
meta: {},
authOptionKey: '<string>',
key: '<string>',
integrationId: '<string>',
integrationUuid: '<string>',
integrationKey: '<string>',
connectorId: '<string>',
connectorUuid: '<string>',
connectorKey: '<string>',
connectorVersion: '<string>',
externalAppId: '<string>',
externalAppUuid: '<string>',
credentials: {},
connectorParameters: {},
input: {},
intent: '<string>'
})
};
fetch('https://api.getmembrane.com/connections/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getmembrane.com/connections/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'meta' => [
],
'authOptionKey' => '<string>',
'key' => '<string>',
'integrationId' => '<string>',
'integrationUuid' => '<string>',
'integrationKey' => '<string>',
'connectorId' => '<string>',
'connectorUuid' => '<string>',
'connectorKey' => '<string>',
'connectorVersion' => '<string>',
'externalAppId' => '<string>',
'externalAppUuid' => '<string>',
'credentials' => [
],
'connectorParameters' => [
],
'input' => [
],
'intent' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.getmembrane.com/connections/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"meta\": {},\n \"authOptionKey\": \"<string>\",\n \"key\": \"<string>\",\n \"integrationId\": \"<string>\",\n \"integrationUuid\": \"<string>\",\n \"integrationKey\": \"<string>\",\n \"connectorId\": \"<string>\",\n \"connectorUuid\": \"<string>\",\n \"connectorKey\": \"<string>\",\n \"connectorVersion\": \"<string>\",\n \"externalAppId\": \"<string>\",\n \"externalAppUuid\": \"<string>\",\n \"credentials\": {},\n \"connectorParameters\": {},\n \"input\": {},\n \"intent\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.getmembrane.com/connections/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"meta\": {},\n \"authOptionKey\": \"<string>\",\n \"key\": \"<string>\",\n \"integrationId\": \"<string>\",\n \"integrationUuid\": \"<string>\",\n \"integrationKey\": \"<string>\",\n \"connectorId\": \"<string>\",\n \"connectorUuid\": \"<string>\",\n \"connectorKey\": \"<string>\",\n \"connectorVersion\": \"<string>\",\n \"externalAppId\": \"<string>\",\n \"externalAppUuid\": \"<string>\",\n \"credentials\": {},\n \"connectorParameters\": {},\n \"input\": {},\n \"intent\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getmembrane.com/connections/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"meta\": {},\n \"authOptionKey\": \"<string>\",\n \"key\": \"<string>\",\n \"integrationId\": \"<string>\",\n \"integrationUuid\": \"<string>\",\n \"integrationKey\": \"<string>\",\n \"connectorId\": \"<string>\",\n \"connectorUuid\": \"<string>\",\n \"connectorKey\": \"<string>\",\n \"connectorVersion\": \"<string>\",\n \"externalAppId\": \"<string>\",\n \"externalAppUuid\": \"<string>\",\n \"credentials\": {},\n \"connectorParameters\": {},\n \"input\": {},\n \"intent\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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>",
"handoffAgentInstructions": "<string>"
},
"user": {
"id": "<string>",
"name": "<string>",
"internalId": "<string>",
"meta": {},
"fields": {},
"credentials": {},
"lastActiveAt": "<string>",
"isTest": true,
"isBillable": true,
"isActive": true,
"aiCreditsRolling30DayLimit": 1,
"createdAt": "<string>",
"archivedAt": "<string>"
},
"integration": {
"id": "<string>",
"name": "<string>",
"logoUri": "<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,
"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": {}
},
"connectorParameters": {},
"input": {}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Available options:
connector, mcp Show child attributes
Show child attributes
Required string length:
1 - 100[Experimental] Intent-based instruction for an agent to configure this element.
Response
200 - application/json
Internal database ID of the element. Assigned by the API; unique per element.
Available options:
connector, mcp Use connected instead.
Available options:
BUILDING, CLIENT_ACTION_REQUIRED, CONFIGURATION_ERROR, SETUP_FAILED, READY, DISCONNECTING Show child attributes
Show child attributes
Show child attributes
Show child attributes
Use requestError and errors instead.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Session ID for building the element via intent-based endpoints (create/update with intent). Present when state is BUILDING.
Action the client must perform to advance this connection. Present if and only if state is CLIENT_ACTION_REQUIRED.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?
⌘I