Update field mapping partially
curl --request PATCH \
--url https://api.getmembrane.com/field-mappings/{selector} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"uuid": "<string>",
"key": "<string>",
"name": "<string>",
"description": "<string>",
"meta": {},
"integrationId": "<string>",
"integrationUuid": "<string>",
"integrationKey": "<string>",
"parentUuid": "<string>",
"parentKey": "<string>",
"connectionId": "<string>",
"instanceKey": "<string>",
"isUniversal": true,
"externalAppId": "<string>",
"externalAppUuid": "<string>",
"externalAppKey": "<string>",
"fieldMappingId": "<string>",
"universalFieldMappingId": "<string>",
"dataSourceId": "<string>",
"dataSourceUuid": "<string>",
"appSchema": {
"type": "<string>",
"title": "<string>",
"description": "<string>",
"format": "<string>",
"properties": {},
"items": "<unknown>",
"additionalProperties": true,
"enum": [
"<string>"
],
"referenceRecords": [
{}
],
"referenceCollection": {
"key": {},
"parameters": {}
},
"referenceUdm": "<string>",
"default": {},
"allowCustom": true,
"required": [
"<string>"
],
"minLength": 123,
"maxLength": 123,
"minimum": 123,
"maximum": 123,
"maxItems": 123,
"readOnly": true,
"writeOnly": true,
"examples": [
{}
],
"anyOf": "<array>",
"isImplied": true,
"isSensitive": true,
"referenceCollectionPath": "<string>",
"referenceCollectionUri": "<string>"
},
"defaultImportValue": {},
"defaultExportValue": {},
"importValue": {},
"exportValue": {},
"unifiedImportValue": {},
"unifiedExportValue": {},
"frozenImportFields": {},
"frozenExportFields": {},
"frozenUnifiedExportFields": {}
}
'import requests
url = "https://api.getmembrane.com/field-mappings/{selector}"
payload = {
"uuid": "<string>",
"key": "<string>",
"name": "<string>",
"description": "<string>",
"meta": {},
"integrationId": "<string>",
"integrationUuid": "<string>",
"integrationKey": "<string>",
"parentUuid": "<string>",
"parentKey": "<string>",
"connectionId": "<string>",
"instanceKey": "<string>",
"isUniversal": True,
"externalAppId": "<string>",
"externalAppUuid": "<string>",
"externalAppKey": "<string>",
"fieldMappingId": "<string>",
"universalFieldMappingId": "<string>",
"dataSourceId": "<string>",
"dataSourceUuid": "<string>",
"appSchema": {
"type": "<string>",
"title": "<string>",
"description": "<string>",
"format": "<string>",
"properties": {},
"items": "<unknown>",
"additionalProperties": True,
"enum": ["<string>"],
"referenceRecords": [{}],
"referenceCollection": {
"key": {},
"parameters": {}
},
"referenceUdm": "<string>",
"default": {},
"allowCustom": True,
"required": ["<string>"],
"minLength": 123,
"maxLength": 123,
"minimum": 123,
"maximum": 123,
"maxItems": 123,
"readOnly": True,
"writeOnly": True,
"examples": [{}],
"anyOf": "<array>",
"isImplied": True,
"isSensitive": True,
"referenceCollectionPath": "<string>",
"referenceCollectionUri": "<string>"
},
"defaultImportValue": {},
"defaultExportValue": {},
"importValue": {},
"exportValue": {},
"unifiedImportValue": {},
"unifiedExportValue": {},
"frozenImportFields": {},
"frozenExportFields": {},
"frozenUnifiedExportFields": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
uuid: '<string>',
key: '<string>',
name: '<string>',
description: '<string>',
meta: {},
integrationId: '<string>',
integrationUuid: '<string>',
integrationKey: '<string>',
parentUuid: '<string>',
parentKey: '<string>',
connectionId: '<string>',
instanceKey: '<string>',
isUniversal: true,
externalAppId: '<string>',
externalAppUuid: '<string>',
externalAppKey: '<string>',
fieldMappingId: '<string>',
universalFieldMappingId: '<string>',
dataSourceId: '<string>',
dataSourceUuid: '<string>',
appSchema: {
type: '<string>',
title: '<string>',
description: '<string>',
format: '<string>',
properties: {},
items: '<unknown>',
additionalProperties: true,
enum: ['<string>'],
referenceRecords: [{}],
referenceCollection: {key: {}, parameters: {}},
referenceUdm: '<string>',
default: {},
allowCustom: true,
required: ['<string>'],
minLength: 123,
maxLength: 123,
minimum: 123,
maximum: 123,
maxItems: 123,
readOnly: true,
writeOnly: true,
examples: [{}],
anyOf: '<array>',
isImplied: true,
isSensitive: true,
referenceCollectionPath: '<string>',
referenceCollectionUri: '<string>'
},
defaultImportValue: {},
defaultExportValue: {},
importValue: {},
exportValue: {},
unifiedImportValue: {},
unifiedExportValue: {},
frozenImportFields: {},
frozenExportFields: {},
frozenUnifiedExportFields: {}
})
};
fetch('https://api.getmembrane.com/field-mappings/{selector}', 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/field-mappings/{selector}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'uuid' => '<string>',
'key' => '<string>',
'name' => '<string>',
'description' => '<string>',
'meta' => [
],
'integrationId' => '<string>',
'integrationUuid' => '<string>',
'integrationKey' => '<string>',
'parentUuid' => '<string>',
'parentKey' => '<string>',
'connectionId' => '<string>',
'instanceKey' => '<string>',
'isUniversal' => true,
'externalAppId' => '<string>',
'externalAppUuid' => '<string>',
'externalAppKey' => '<string>',
'fieldMappingId' => '<string>',
'universalFieldMappingId' => '<string>',
'dataSourceId' => '<string>',
'dataSourceUuid' => '<string>',
'appSchema' => [
'type' => '<string>',
'title' => '<string>',
'description' => '<string>',
'format' => '<string>',
'properties' => [
],
'items' => '<unknown>',
'additionalProperties' => true,
'enum' => [
'<string>'
],
'referenceRecords' => [
[
]
],
'referenceCollection' => [
'key' => [
],
'parameters' => [
]
],
'referenceUdm' => '<string>',
'default' => [
],
'allowCustom' => true,
'required' => [
'<string>'
],
'minLength' => 123,
'maxLength' => 123,
'minimum' => 123,
'maximum' => 123,
'maxItems' => 123,
'readOnly' => true,
'writeOnly' => true,
'examples' => [
[
]
],
'anyOf' => '<array>',
'isImplied' => true,
'isSensitive' => true,
'referenceCollectionPath' => '<string>',
'referenceCollectionUri' => '<string>'
],
'defaultImportValue' => [
],
'defaultExportValue' => [
],
'importValue' => [
],
'exportValue' => [
],
'unifiedImportValue' => [
],
'unifiedExportValue' => [
],
'frozenImportFields' => [
],
'frozenExportFields' => [
],
'frozenUnifiedExportFields' => [
]
]),
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/field-mappings/{selector}"
payload := strings.NewReader("{\n \"uuid\": \"<string>\",\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"meta\": {},\n \"integrationId\": \"<string>\",\n \"integrationUuid\": \"<string>\",\n \"integrationKey\": \"<string>\",\n \"parentUuid\": \"<string>\",\n \"parentKey\": \"<string>\",\n \"connectionId\": \"<string>\",\n \"instanceKey\": \"<string>\",\n \"isUniversal\": true,\n \"externalAppId\": \"<string>\",\n \"externalAppUuid\": \"<string>\",\n \"externalAppKey\": \"<string>\",\n \"fieldMappingId\": \"<string>\",\n \"universalFieldMappingId\": \"<string>\",\n \"dataSourceId\": \"<string>\",\n \"dataSourceUuid\": \"<string>\",\n \"appSchema\": {\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"format\": \"<string>\",\n \"properties\": {},\n \"items\": \"<unknown>\",\n \"additionalProperties\": true,\n \"enum\": [\n \"<string>\"\n ],\n \"referenceRecords\": [\n {}\n ],\n \"referenceCollection\": {\n \"key\": {},\n \"parameters\": {}\n },\n \"referenceUdm\": \"<string>\",\n \"default\": {},\n \"allowCustom\": true,\n \"required\": [\n \"<string>\"\n ],\n \"minLength\": 123,\n \"maxLength\": 123,\n \"minimum\": 123,\n \"maximum\": 123,\n \"maxItems\": 123,\n \"readOnly\": true,\n \"writeOnly\": true,\n \"examples\": [\n {}\n ],\n \"anyOf\": \"<array>\",\n \"isImplied\": true,\n \"isSensitive\": true,\n \"referenceCollectionPath\": \"<string>\",\n \"referenceCollectionUri\": \"<string>\"\n },\n \"defaultImportValue\": {},\n \"defaultExportValue\": {},\n \"importValue\": {},\n \"exportValue\": {},\n \"unifiedImportValue\": {},\n \"unifiedExportValue\": {},\n \"frozenImportFields\": {},\n \"frozenExportFields\": {},\n \"frozenUnifiedExportFields\": {}\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.getmembrane.com/field-mappings/{selector}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"uuid\": \"<string>\",\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"meta\": {},\n \"integrationId\": \"<string>\",\n \"integrationUuid\": \"<string>\",\n \"integrationKey\": \"<string>\",\n \"parentUuid\": \"<string>\",\n \"parentKey\": \"<string>\",\n \"connectionId\": \"<string>\",\n \"instanceKey\": \"<string>\",\n \"isUniversal\": true,\n \"externalAppId\": \"<string>\",\n \"externalAppUuid\": \"<string>\",\n \"externalAppKey\": \"<string>\",\n \"fieldMappingId\": \"<string>\",\n \"universalFieldMappingId\": \"<string>\",\n \"dataSourceId\": \"<string>\",\n \"dataSourceUuid\": \"<string>\",\n \"appSchema\": {\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"format\": \"<string>\",\n \"properties\": {},\n \"items\": \"<unknown>\",\n \"additionalProperties\": true,\n \"enum\": [\n \"<string>\"\n ],\n \"referenceRecords\": [\n {}\n ],\n \"referenceCollection\": {\n \"key\": {},\n \"parameters\": {}\n },\n \"referenceUdm\": \"<string>\",\n \"default\": {},\n \"allowCustom\": true,\n \"required\": [\n \"<string>\"\n ],\n \"minLength\": 123,\n \"maxLength\": 123,\n \"minimum\": 123,\n \"maximum\": 123,\n \"maxItems\": 123,\n \"readOnly\": true,\n \"writeOnly\": true,\n \"examples\": [\n {}\n ],\n \"anyOf\": \"<array>\",\n \"isImplied\": true,\n \"isSensitive\": true,\n \"referenceCollectionPath\": \"<string>\",\n \"referenceCollectionUri\": \"<string>\"\n },\n \"defaultImportValue\": {},\n \"defaultExportValue\": {},\n \"importValue\": {},\n \"exportValue\": {},\n \"unifiedImportValue\": {},\n \"unifiedExportValue\": {},\n \"frozenImportFields\": {},\n \"frozenExportFields\": {},\n \"frozenUnifiedExportFields\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getmembrane.com/field-mappings/{selector}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"uuid\": \"<string>\",\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"meta\": {},\n \"integrationId\": \"<string>\",\n \"integrationUuid\": \"<string>\",\n \"integrationKey\": \"<string>\",\n \"parentUuid\": \"<string>\",\n \"parentKey\": \"<string>\",\n \"connectionId\": \"<string>\",\n \"instanceKey\": \"<string>\",\n \"isUniversal\": true,\n \"externalAppId\": \"<string>\",\n \"externalAppUuid\": \"<string>\",\n \"externalAppKey\": \"<string>\",\n \"fieldMappingId\": \"<string>\",\n \"universalFieldMappingId\": \"<string>\",\n \"dataSourceId\": \"<string>\",\n \"dataSourceUuid\": \"<string>\",\n \"appSchema\": {\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"format\": \"<string>\",\n \"properties\": {},\n \"items\": \"<unknown>\",\n \"additionalProperties\": true,\n \"enum\": [\n \"<string>\"\n ],\n \"referenceRecords\": [\n {}\n ],\n \"referenceCollection\": {\n \"key\": {},\n \"parameters\": {}\n },\n \"referenceUdm\": \"<string>\",\n \"default\": {},\n \"allowCustom\": true,\n \"required\": [\n \"<string>\"\n ],\n \"minLength\": 123,\n \"maxLength\": 123,\n \"minimum\": 123,\n \"maximum\": 123,\n \"maxItems\": 123,\n \"readOnly\": true,\n \"writeOnly\": true,\n \"examples\": [\n {}\n ],\n \"anyOf\": \"<array>\",\n \"isImplied\": true,\n \"isSensitive\": true,\n \"referenceCollectionPath\": \"<string>\",\n \"referenceCollectionUri\": \"<string>\"\n },\n \"defaultImportValue\": {},\n \"defaultExportValue\": {},\n \"importValue\": {},\n \"exportValue\": {},\n \"unifiedImportValue\": {},\n \"unifiedExportValue\": {},\n \"frozenImportFields\": {},\n \"frozenExportFields\": {},\n \"frozenUnifiedExportFields\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<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,
"integrationId": "<string>",
"integrationUuid": "<string>",
"integrationKey": "<string>",
"parentUuid": "<string>",
"parentKey": "<string>",
"connectionId": "<string>",
"instanceKey": "<string>",
"isUniversal": true,
"externalAppId": "<string>",
"externalAppUuid": "<string>",
"externalAppKey": "<string>",
"fieldMappingId": "<string>",
"universalFieldMappingId": "<string>",
"dataSourceId": "<string>",
"dataSourceUuid": "<string>",
"appSchema": {
"type": "<string>",
"title": "<string>",
"description": "<string>",
"format": "<string>",
"properties": {},
"items": "<unknown>",
"additionalProperties": true,
"enum": [
"<string>"
],
"referenceRecords": [
{}
],
"referenceCollection": {
"key": {},
"parameters": {}
},
"referenceUdm": "<string>",
"default": {},
"allowCustom": true,
"required": [
"<string>"
],
"minLength": 123,
"maxLength": 123,
"minimum": 123,
"maximum": 123,
"maxItems": 123,
"readOnly": true,
"writeOnly": true,
"examples": [
{}
],
"anyOf": "<array>",
"isImplied": true,
"isSensitive": true,
"referenceCollectionPath": "<string>",
"referenceCollectionUri": "<string>"
},
"defaultImportValue": {},
"defaultExportValue": {},
"importValue": {},
"exportValue": {},
"unifiedImportValue": {},
"unifiedExportValue": {},
"frozenImportFields": {},
"frozenExportFields": {},
"frozenUnifiedExportFields": {},
"isCustomized": true,
"userId": "<string>",
"tenantId": "<string>",
"fieldMappingRevision": "<string>",
"universalFieldMappingRevision": "<string>",
"dataSourceInstanceId": "<string>",
"dataSourceSchema": {
"type": "<string>",
"title": "<string>",
"description": "<string>",
"format": "<string>",
"properties": {},
"items": "<unknown>",
"additionalProperties": true,
"enum": [
"<string>"
],
"referenceRecords": [
{}
],
"referenceCollection": {
"key": {},
"parameters": {}
},
"referenceUdm": "<string>",
"default": {},
"allowCustom": true,
"required": [
"<string>"
],
"minLength": 123,
"maxLength": 123,
"minimum": 123,
"maximum": 123,
"maxItems": 123,
"readOnly": true,
"writeOnly": true,
"examples": [
{}
],
"anyOf": "<array>",
"isImplied": true,
"isSensitive": true,
"referenceCollectionPath": "<string>",
"referenceCollectionUri": "<string>"
},
"error": {
"message": "<string>",
"key": "<string>",
"data": {},
"stack": {},
"causedByError": "<unknown>",
"logs": [
{}
]
},
"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": {}
},
"appliedToIntegrations": [
{
"element": {
"id": "<string>",
"name": "<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,
"integrationId": "<string>",
"integrationUuid": "<string>",
"integrationKey": "<string>",
"parentUuid": "<string>",
"parentKey": "<string>",
"connectionId": "<string>",
"instanceKey": "<string>",
"isUniversal": true,
"externalAppId": "<string>",
"externalAppUuid": "<string>",
"externalAppKey": "<string>",
"fieldMappingId": "<string>",
"universalFieldMappingId": "<string>",
"dataSourceId": "<string>",
"dataSourceUuid": "<string>",
"appSchema": {
"type": "<string>",
"title": "<string>",
"description": "<string>",
"format": "<string>",
"properties": {},
"items": "<unknown>",
"additionalProperties": true,
"enum": [
"<string>"
],
"referenceRecords": [
{}
],
"referenceCollection": {
"key": {},
"parameters": {}
},
"referenceUdm": "<string>",
"default": {},
"allowCustom": true,
"required": [
"<string>"
],
"minLength": 123,
"maxLength": 123,
"minimum": 123,
"maximum": 123,
"maxItems": 123,
"readOnly": true,
"writeOnly": true,
"examples": [
{}
],
"anyOf": "<array>",
"isImplied": true,
"isSensitive": true,
"referenceCollectionPath": "<string>",
"referenceCollectionUri": "<string>"
},
"defaultImportValue": {},
"defaultExportValue": {},
"importValue": {},
"exportValue": {},
"unifiedImportValue": {},
"unifiedExportValue": {},
"frozenImportFields": {},
"frozenExportFields": {},
"frozenUnifiedExportFields": {},
"isCustomized": true,
"userId": "<string>",
"tenantId": "<string>",
"fieldMappingRevision": "<string>",
"universalFieldMappingRevision": "<string>",
"dataSourceInstanceId": "<string>",
"dataSourceSchema": {
"type": "<string>",
"title": "<string>",
"description": "<string>",
"format": "<string>",
"properties": {},
"items": "<unknown>",
"additionalProperties": true,
"enum": [
"<string>"
],
"referenceRecords": [
{}
],
"referenceCollection": {
"key": {},
"parameters": {}
},
"referenceUdm": "<string>",
"default": {},
"allowCustom": true,
"required": [
"<string>"
],
"minLength": 123,
"maxLength": 123,
"minimum": 123,
"maximum": 123,
"maxItems": 123,
"readOnly": true,
"writeOnly": true,
"examples": [
{}
],
"anyOf": "<array>",
"isImplied": true,
"isSensitive": true,
"referenceCollectionPath": "<string>",
"referenceCollectionUri": "<string>"
},
"error": {
"message": "<string>",
"key": "<string>",
"data": {},
"stack": {},
"causedByError": "<unknown>",
"logs": [
{}
]
}
},
"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": {}
}
}
],
"user": {
"id": "<string>",
"name": "<string>",
"internalId": "<string>",
"meta": {},
"fields": {},
"credentials": {},
"lastActiveAt": "<string>",
"isTest": true,
"isBillable": true,
"isActive": true,
"aiCreditsRolling30DayLimit": 1,
"createdAt": "<string>",
"archivedAt": "<string>"
},
"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>",
"handoffAgentInstructions": "<string>"
}
},
"fieldMapping": {
"id": "<string>",
"name": "<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,
"integrationId": "<string>",
"integrationUuid": "<string>",
"integrationKey": "<string>",
"parentUuid": "<string>",
"parentKey": "<string>",
"connectionId": "<string>",
"instanceKey": "<string>",
"isUniversal": true,
"externalAppId": "<string>",
"externalAppUuid": "<string>",
"externalAppKey": "<string>",
"fieldMappingId": "<string>",
"universalFieldMappingId": "<string>",
"dataSourceId": "<string>",
"dataSourceUuid": "<string>",
"appSchema": {
"type": "<string>",
"title": "<string>",
"description": "<string>",
"format": "<string>",
"properties": {},
"items": "<unknown>",
"additionalProperties": true,
"enum": [
"<string>"
],
"referenceRecords": [
{}
],
"referenceCollection": {
"key": {},
"parameters": {}
},
"referenceUdm": "<string>",
"default": {},
"allowCustom": true,
"required": [
"<string>"
],
"minLength": 123,
"maxLength": 123,
"minimum": 123,
"maximum": 123,
"maxItems": 123,
"readOnly": true,
"writeOnly": true,
"examples": [
{}
],
"anyOf": "<array>",
"isImplied": true,
"isSensitive": true,
"referenceCollectionPath": "<string>",
"referenceCollectionUri": "<string>"
},
"defaultImportValue": {},
"defaultExportValue": {},
"importValue": {},
"exportValue": {},
"unifiedImportValue": {},
"unifiedExportValue": {},
"frozenImportFields": {},
"frozenExportFields": {},
"frozenUnifiedExportFields": {},
"isCustomized": true,
"userId": "<string>",
"tenantId": "<string>",
"fieldMappingRevision": "<string>",
"universalFieldMappingRevision": "<string>",
"dataSourceInstanceId": "<string>",
"dataSourceSchema": {
"type": "<string>",
"title": "<string>",
"description": "<string>",
"format": "<string>",
"properties": {},
"items": "<unknown>",
"additionalProperties": true,
"enum": [
"<string>"
],
"referenceRecords": [
{}
],
"referenceCollection": {
"key": {},
"parameters": {}
},
"referenceUdm": "<string>",
"default": {},
"allowCustom": true,
"required": [
"<string>"
],
"minLength": 123,
"maxLength": 123,
"minimum": 123,
"maximum": 123,
"maxItems": 123,
"readOnly": true,
"writeOnly": true,
"examples": [
{}
],
"anyOf": "<array>",
"isImplied": true,
"isSensitive": true,
"referenceCollectionPath": "<string>",
"referenceCollectionUri": "<string>"
},
"error": {
"message": "<string>",
"key": "<string>",
"data": {},
"stack": {},
"causedByError": "<unknown>",
"logs": [
{}
]
}
}
}Field Mappings
Update field mapping partially
PATCH
/
field-mappings
/
{selector}
Update field mapping partially
curl --request PATCH \
--url https://api.getmembrane.com/field-mappings/{selector} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"uuid": "<string>",
"key": "<string>",
"name": "<string>",
"description": "<string>",
"meta": {},
"integrationId": "<string>",
"integrationUuid": "<string>",
"integrationKey": "<string>",
"parentUuid": "<string>",
"parentKey": "<string>",
"connectionId": "<string>",
"instanceKey": "<string>",
"isUniversal": true,
"externalAppId": "<string>",
"externalAppUuid": "<string>",
"externalAppKey": "<string>",
"fieldMappingId": "<string>",
"universalFieldMappingId": "<string>",
"dataSourceId": "<string>",
"dataSourceUuid": "<string>",
"appSchema": {
"type": "<string>",
"title": "<string>",
"description": "<string>",
"format": "<string>",
"properties": {},
"items": "<unknown>",
"additionalProperties": true,
"enum": [
"<string>"
],
"referenceRecords": [
{}
],
"referenceCollection": {
"key": {},
"parameters": {}
},
"referenceUdm": "<string>",
"default": {},
"allowCustom": true,
"required": [
"<string>"
],
"minLength": 123,
"maxLength": 123,
"minimum": 123,
"maximum": 123,
"maxItems": 123,
"readOnly": true,
"writeOnly": true,
"examples": [
{}
],
"anyOf": "<array>",
"isImplied": true,
"isSensitive": true,
"referenceCollectionPath": "<string>",
"referenceCollectionUri": "<string>"
},
"defaultImportValue": {},
"defaultExportValue": {},
"importValue": {},
"exportValue": {},
"unifiedImportValue": {},
"unifiedExportValue": {},
"frozenImportFields": {},
"frozenExportFields": {},
"frozenUnifiedExportFields": {}
}
'import requests
url = "https://api.getmembrane.com/field-mappings/{selector}"
payload = {
"uuid": "<string>",
"key": "<string>",
"name": "<string>",
"description": "<string>",
"meta": {},
"integrationId": "<string>",
"integrationUuid": "<string>",
"integrationKey": "<string>",
"parentUuid": "<string>",
"parentKey": "<string>",
"connectionId": "<string>",
"instanceKey": "<string>",
"isUniversal": True,
"externalAppId": "<string>",
"externalAppUuid": "<string>",
"externalAppKey": "<string>",
"fieldMappingId": "<string>",
"universalFieldMappingId": "<string>",
"dataSourceId": "<string>",
"dataSourceUuid": "<string>",
"appSchema": {
"type": "<string>",
"title": "<string>",
"description": "<string>",
"format": "<string>",
"properties": {},
"items": "<unknown>",
"additionalProperties": True,
"enum": ["<string>"],
"referenceRecords": [{}],
"referenceCollection": {
"key": {},
"parameters": {}
},
"referenceUdm": "<string>",
"default": {},
"allowCustom": True,
"required": ["<string>"],
"minLength": 123,
"maxLength": 123,
"minimum": 123,
"maximum": 123,
"maxItems": 123,
"readOnly": True,
"writeOnly": True,
"examples": [{}],
"anyOf": "<array>",
"isImplied": True,
"isSensitive": True,
"referenceCollectionPath": "<string>",
"referenceCollectionUri": "<string>"
},
"defaultImportValue": {},
"defaultExportValue": {},
"importValue": {},
"exportValue": {},
"unifiedImportValue": {},
"unifiedExportValue": {},
"frozenImportFields": {},
"frozenExportFields": {},
"frozenUnifiedExportFields": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
uuid: '<string>',
key: '<string>',
name: '<string>',
description: '<string>',
meta: {},
integrationId: '<string>',
integrationUuid: '<string>',
integrationKey: '<string>',
parentUuid: '<string>',
parentKey: '<string>',
connectionId: '<string>',
instanceKey: '<string>',
isUniversal: true,
externalAppId: '<string>',
externalAppUuid: '<string>',
externalAppKey: '<string>',
fieldMappingId: '<string>',
universalFieldMappingId: '<string>',
dataSourceId: '<string>',
dataSourceUuid: '<string>',
appSchema: {
type: '<string>',
title: '<string>',
description: '<string>',
format: '<string>',
properties: {},
items: '<unknown>',
additionalProperties: true,
enum: ['<string>'],
referenceRecords: [{}],
referenceCollection: {key: {}, parameters: {}},
referenceUdm: '<string>',
default: {},
allowCustom: true,
required: ['<string>'],
minLength: 123,
maxLength: 123,
minimum: 123,
maximum: 123,
maxItems: 123,
readOnly: true,
writeOnly: true,
examples: [{}],
anyOf: '<array>',
isImplied: true,
isSensitive: true,
referenceCollectionPath: '<string>',
referenceCollectionUri: '<string>'
},
defaultImportValue: {},
defaultExportValue: {},
importValue: {},
exportValue: {},
unifiedImportValue: {},
unifiedExportValue: {},
frozenImportFields: {},
frozenExportFields: {},
frozenUnifiedExportFields: {}
})
};
fetch('https://api.getmembrane.com/field-mappings/{selector}', 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/field-mappings/{selector}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'uuid' => '<string>',
'key' => '<string>',
'name' => '<string>',
'description' => '<string>',
'meta' => [
],
'integrationId' => '<string>',
'integrationUuid' => '<string>',
'integrationKey' => '<string>',
'parentUuid' => '<string>',
'parentKey' => '<string>',
'connectionId' => '<string>',
'instanceKey' => '<string>',
'isUniversal' => true,
'externalAppId' => '<string>',
'externalAppUuid' => '<string>',
'externalAppKey' => '<string>',
'fieldMappingId' => '<string>',
'universalFieldMappingId' => '<string>',
'dataSourceId' => '<string>',
'dataSourceUuid' => '<string>',
'appSchema' => [
'type' => '<string>',
'title' => '<string>',
'description' => '<string>',
'format' => '<string>',
'properties' => [
],
'items' => '<unknown>',
'additionalProperties' => true,
'enum' => [
'<string>'
],
'referenceRecords' => [
[
]
],
'referenceCollection' => [
'key' => [
],
'parameters' => [
]
],
'referenceUdm' => '<string>',
'default' => [
],
'allowCustom' => true,
'required' => [
'<string>'
],
'minLength' => 123,
'maxLength' => 123,
'minimum' => 123,
'maximum' => 123,
'maxItems' => 123,
'readOnly' => true,
'writeOnly' => true,
'examples' => [
[
]
],
'anyOf' => '<array>',
'isImplied' => true,
'isSensitive' => true,
'referenceCollectionPath' => '<string>',
'referenceCollectionUri' => '<string>'
],
'defaultImportValue' => [
],
'defaultExportValue' => [
],
'importValue' => [
],
'exportValue' => [
],
'unifiedImportValue' => [
],
'unifiedExportValue' => [
],
'frozenImportFields' => [
],
'frozenExportFields' => [
],
'frozenUnifiedExportFields' => [
]
]),
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/field-mappings/{selector}"
payload := strings.NewReader("{\n \"uuid\": \"<string>\",\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"meta\": {},\n \"integrationId\": \"<string>\",\n \"integrationUuid\": \"<string>\",\n \"integrationKey\": \"<string>\",\n \"parentUuid\": \"<string>\",\n \"parentKey\": \"<string>\",\n \"connectionId\": \"<string>\",\n \"instanceKey\": \"<string>\",\n \"isUniversal\": true,\n \"externalAppId\": \"<string>\",\n \"externalAppUuid\": \"<string>\",\n \"externalAppKey\": \"<string>\",\n \"fieldMappingId\": \"<string>\",\n \"universalFieldMappingId\": \"<string>\",\n \"dataSourceId\": \"<string>\",\n \"dataSourceUuid\": \"<string>\",\n \"appSchema\": {\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"format\": \"<string>\",\n \"properties\": {},\n \"items\": \"<unknown>\",\n \"additionalProperties\": true,\n \"enum\": [\n \"<string>\"\n ],\n \"referenceRecords\": [\n {}\n ],\n \"referenceCollection\": {\n \"key\": {},\n \"parameters\": {}\n },\n \"referenceUdm\": \"<string>\",\n \"default\": {},\n \"allowCustom\": true,\n \"required\": [\n \"<string>\"\n ],\n \"minLength\": 123,\n \"maxLength\": 123,\n \"minimum\": 123,\n \"maximum\": 123,\n \"maxItems\": 123,\n \"readOnly\": true,\n \"writeOnly\": true,\n \"examples\": [\n {}\n ],\n \"anyOf\": \"<array>\",\n \"isImplied\": true,\n \"isSensitive\": true,\n \"referenceCollectionPath\": \"<string>\",\n \"referenceCollectionUri\": \"<string>\"\n },\n \"defaultImportValue\": {},\n \"defaultExportValue\": {},\n \"importValue\": {},\n \"exportValue\": {},\n \"unifiedImportValue\": {},\n \"unifiedExportValue\": {},\n \"frozenImportFields\": {},\n \"frozenExportFields\": {},\n \"frozenUnifiedExportFields\": {}\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.getmembrane.com/field-mappings/{selector}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"uuid\": \"<string>\",\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"meta\": {},\n \"integrationId\": \"<string>\",\n \"integrationUuid\": \"<string>\",\n \"integrationKey\": \"<string>\",\n \"parentUuid\": \"<string>\",\n \"parentKey\": \"<string>\",\n \"connectionId\": \"<string>\",\n \"instanceKey\": \"<string>\",\n \"isUniversal\": true,\n \"externalAppId\": \"<string>\",\n \"externalAppUuid\": \"<string>\",\n \"externalAppKey\": \"<string>\",\n \"fieldMappingId\": \"<string>\",\n \"universalFieldMappingId\": \"<string>\",\n \"dataSourceId\": \"<string>\",\n \"dataSourceUuid\": \"<string>\",\n \"appSchema\": {\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"format\": \"<string>\",\n \"properties\": {},\n \"items\": \"<unknown>\",\n \"additionalProperties\": true,\n \"enum\": [\n \"<string>\"\n ],\n \"referenceRecords\": [\n {}\n ],\n \"referenceCollection\": {\n \"key\": {},\n \"parameters\": {}\n },\n \"referenceUdm\": \"<string>\",\n \"default\": {},\n \"allowCustom\": true,\n \"required\": [\n \"<string>\"\n ],\n \"minLength\": 123,\n \"maxLength\": 123,\n \"minimum\": 123,\n \"maximum\": 123,\n \"maxItems\": 123,\n \"readOnly\": true,\n \"writeOnly\": true,\n \"examples\": [\n {}\n ],\n \"anyOf\": \"<array>\",\n \"isImplied\": true,\n \"isSensitive\": true,\n \"referenceCollectionPath\": \"<string>\",\n \"referenceCollectionUri\": \"<string>\"\n },\n \"defaultImportValue\": {},\n \"defaultExportValue\": {},\n \"importValue\": {},\n \"exportValue\": {},\n \"unifiedImportValue\": {},\n \"unifiedExportValue\": {},\n \"frozenImportFields\": {},\n \"frozenExportFields\": {},\n \"frozenUnifiedExportFields\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getmembrane.com/field-mappings/{selector}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"uuid\": \"<string>\",\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"meta\": {},\n \"integrationId\": \"<string>\",\n \"integrationUuid\": \"<string>\",\n \"integrationKey\": \"<string>\",\n \"parentUuid\": \"<string>\",\n \"parentKey\": \"<string>\",\n \"connectionId\": \"<string>\",\n \"instanceKey\": \"<string>\",\n \"isUniversal\": true,\n \"externalAppId\": \"<string>\",\n \"externalAppUuid\": \"<string>\",\n \"externalAppKey\": \"<string>\",\n \"fieldMappingId\": \"<string>\",\n \"universalFieldMappingId\": \"<string>\",\n \"dataSourceId\": \"<string>\",\n \"dataSourceUuid\": \"<string>\",\n \"appSchema\": {\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"format\": \"<string>\",\n \"properties\": {},\n \"items\": \"<unknown>\",\n \"additionalProperties\": true,\n \"enum\": [\n \"<string>\"\n ],\n \"referenceRecords\": [\n {}\n ],\n \"referenceCollection\": {\n \"key\": {},\n \"parameters\": {}\n },\n \"referenceUdm\": \"<string>\",\n \"default\": {},\n \"allowCustom\": true,\n \"required\": [\n \"<string>\"\n ],\n \"minLength\": 123,\n \"maxLength\": 123,\n \"minimum\": 123,\n \"maximum\": 123,\n \"maxItems\": 123,\n \"readOnly\": true,\n \"writeOnly\": true,\n \"examples\": [\n {}\n ],\n \"anyOf\": \"<array>\",\n \"isImplied\": true,\n \"isSensitive\": true,\n \"referenceCollectionPath\": \"<string>\",\n \"referenceCollectionUri\": \"<string>\"\n },\n \"defaultImportValue\": {},\n \"defaultExportValue\": {},\n \"importValue\": {},\n \"exportValue\": {},\n \"unifiedImportValue\": {},\n \"unifiedExportValue\": {},\n \"frozenImportFields\": {},\n \"frozenExportFields\": {},\n \"frozenUnifiedExportFields\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<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,
"integrationId": "<string>",
"integrationUuid": "<string>",
"integrationKey": "<string>",
"parentUuid": "<string>",
"parentKey": "<string>",
"connectionId": "<string>",
"instanceKey": "<string>",
"isUniversal": true,
"externalAppId": "<string>",
"externalAppUuid": "<string>",
"externalAppKey": "<string>",
"fieldMappingId": "<string>",
"universalFieldMappingId": "<string>",
"dataSourceId": "<string>",
"dataSourceUuid": "<string>",
"appSchema": {
"type": "<string>",
"title": "<string>",
"description": "<string>",
"format": "<string>",
"properties": {},
"items": "<unknown>",
"additionalProperties": true,
"enum": [
"<string>"
],
"referenceRecords": [
{}
],
"referenceCollection": {
"key": {},
"parameters": {}
},
"referenceUdm": "<string>",
"default": {},
"allowCustom": true,
"required": [
"<string>"
],
"minLength": 123,
"maxLength": 123,
"minimum": 123,
"maximum": 123,
"maxItems": 123,
"readOnly": true,
"writeOnly": true,
"examples": [
{}
],
"anyOf": "<array>",
"isImplied": true,
"isSensitive": true,
"referenceCollectionPath": "<string>",
"referenceCollectionUri": "<string>"
},
"defaultImportValue": {},
"defaultExportValue": {},
"importValue": {},
"exportValue": {},
"unifiedImportValue": {},
"unifiedExportValue": {},
"frozenImportFields": {},
"frozenExportFields": {},
"frozenUnifiedExportFields": {},
"isCustomized": true,
"userId": "<string>",
"tenantId": "<string>",
"fieldMappingRevision": "<string>",
"universalFieldMappingRevision": "<string>",
"dataSourceInstanceId": "<string>",
"dataSourceSchema": {
"type": "<string>",
"title": "<string>",
"description": "<string>",
"format": "<string>",
"properties": {},
"items": "<unknown>",
"additionalProperties": true,
"enum": [
"<string>"
],
"referenceRecords": [
{}
],
"referenceCollection": {
"key": {},
"parameters": {}
},
"referenceUdm": "<string>",
"default": {},
"allowCustom": true,
"required": [
"<string>"
],
"minLength": 123,
"maxLength": 123,
"minimum": 123,
"maximum": 123,
"maxItems": 123,
"readOnly": true,
"writeOnly": true,
"examples": [
{}
],
"anyOf": "<array>",
"isImplied": true,
"isSensitive": true,
"referenceCollectionPath": "<string>",
"referenceCollectionUri": "<string>"
},
"error": {
"message": "<string>",
"key": "<string>",
"data": {},
"stack": {},
"causedByError": "<unknown>",
"logs": [
{}
]
},
"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": {}
},
"appliedToIntegrations": [
{
"element": {
"id": "<string>",
"name": "<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,
"integrationId": "<string>",
"integrationUuid": "<string>",
"integrationKey": "<string>",
"parentUuid": "<string>",
"parentKey": "<string>",
"connectionId": "<string>",
"instanceKey": "<string>",
"isUniversal": true,
"externalAppId": "<string>",
"externalAppUuid": "<string>",
"externalAppKey": "<string>",
"fieldMappingId": "<string>",
"universalFieldMappingId": "<string>",
"dataSourceId": "<string>",
"dataSourceUuid": "<string>",
"appSchema": {
"type": "<string>",
"title": "<string>",
"description": "<string>",
"format": "<string>",
"properties": {},
"items": "<unknown>",
"additionalProperties": true,
"enum": [
"<string>"
],
"referenceRecords": [
{}
],
"referenceCollection": {
"key": {},
"parameters": {}
},
"referenceUdm": "<string>",
"default": {},
"allowCustom": true,
"required": [
"<string>"
],
"minLength": 123,
"maxLength": 123,
"minimum": 123,
"maximum": 123,
"maxItems": 123,
"readOnly": true,
"writeOnly": true,
"examples": [
{}
],
"anyOf": "<array>",
"isImplied": true,
"isSensitive": true,
"referenceCollectionPath": "<string>",
"referenceCollectionUri": "<string>"
},
"defaultImportValue": {},
"defaultExportValue": {},
"importValue": {},
"exportValue": {},
"unifiedImportValue": {},
"unifiedExportValue": {},
"frozenImportFields": {},
"frozenExportFields": {},
"frozenUnifiedExportFields": {},
"isCustomized": true,
"userId": "<string>",
"tenantId": "<string>",
"fieldMappingRevision": "<string>",
"universalFieldMappingRevision": "<string>",
"dataSourceInstanceId": "<string>",
"dataSourceSchema": {
"type": "<string>",
"title": "<string>",
"description": "<string>",
"format": "<string>",
"properties": {},
"items": "<unknown>",
"additionalProperties": true,
"enum": [
"<string>"
],
"referenceRecords": [
{}
],
"referenceCollection": {
"key": {},
"parameters": {}
},
"referenceUdm": "<string>",
"default": {},
"allowCustom": true,
"required": [
"<string>"
],
"minLength": 123,
"maxLength": 123,
"minimum": 123,
"maximum": 123,
"maxItems": 123,
"readOnly": true,
"writeOnly": true,
"examples": [
{}
],
"anyOf": "<array>",
"isImplied": true,
"isSensitive": true,
"referenceCollectionPath": "<string>",
"referenceCollectionUri": "<string>"
},
"error": {
"message": "<string>",
"key": "<string>",
"data": {},
"stack": {},
"causedByError": "<unknown>",
"logs": [
{}
]
}
},
"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": {}
}
}
],
"user": {
"id": "<string>",
"name": "<string>",
"internalId": "<string>",
"meta": {},
"fields": {},
"credentials": {},
"lastActiveAt": "<string>",
"isTest": true,
"isBillable": true,
"isActive": true,
"aiCreditsRolling30DayLimit": 1,
"createdAt": "<string>",
"archivedAt": "<string>"
},
"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>",
"handoffAgentInstructions": "<string>"
}
},
"fieldMapping": {
"id": "<string>",
"name": "<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,
"integrationId": "<string>",
"integrationUuid": "<string>",
"integrationKey": "<string>",
"parentUuid": "<string>",
"parentKey": "<string>",
"connectionId": "<string>",
"instanceKey": "<string>",
"isUniversal": true,
"externalAppId": "<string>",
"externalAppUuid": "<string>",
"externalAppKey": "<string>",
"fieldMappingId": "<string>",
"universalFieldMappingId": "<string>",
"dataSourceId": "<string>",
"dataSourceUuid": "<string>",
"appSchema": {
"type": "<string>",
"title": "<string>",
"description": "<string>",
"format": "<string>",
"properties": {},
"items": "<unknown>",
"additionalProperties": true,
"enum": [
"<string>"
],
"referenceRecords": [
{}
],
"referenceCollection": {
"key": {},
"parameters": {}
},
"referenceUdm": "<string>",
"default": {},
"allowCustom": true,
"required": [
"<string>"
],
"minLength": 123,
"maxLength": 123,
"minimum": 123,
"maximum": 123,
"maxItems": 123,
"readOnly": true,
"writeOnly": true,
"examples": [
{}
],
"anyOf": "<array>",
"isImplied": true,
"isSensitive": true,
"referenceCollectionPath": "<string>",
"referenceCollectionUri": "<string>"
},
"defaultImportValue": {},
"defaultExportValue": {},
"importValue": {},
"exportValue": {},
"unifiedImportValue": {},
"unifiedExportValue": {},
"frozenImportFields": {},
"frozenExportFields": {},
"frozenUnifiedExportFields": {},
"isCustomized": true,
"userId": "<string>",
"tenantId": "<string>",
"fieldMappingRevision": "<string>",
"universalFieldMappingRevision": "<string>",
"dataSourceInstanceId": "<string>",
"dataSourceSchema": {
"type": "<string>",
"title": "<string>",
"description": "<string>",
"format": "<string>",
"properties": {},
"items": "<unknown>",
"additionalProperties": true,
"enum": [
"<string>"
],
"referenceRecords": [
{}
],
"referenceCollection": {
"key": {},
"parameters": {}
},
"referenceUdm": "<string>",
"default": {},
"allowCustom": true,
"required": [
"<string>"
],
"minLength": 123,
"maxLength": 123,
"minimum": 123,
"maximum": 123,
"maxItems": 123,
"readOnly": true,
"writeOnly": true,
"examples": [
{}
],
"anyOf": "<array>",
"isImplied": true,
"isSensitive": true,
"referenceCollectionPath": "<string>",
"referenceCollectionUri": "<string>"
},
"error": {
"message": "<string>",
"key": "<string>",
"data": {},
"stack": {},
"causedByError": "<unknown>",
"logs": [
{}
]
}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Query Parameters
Available options:
universal, integration, connection Body
application/json
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.
Show child attributes
Show child attributes
Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.
UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.
Key of the integration; alternative to integrationId. Resolved to integrationId by the API.
UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.
Key of the parent element; alternative to parentId. Resolved to parentId by the API.
When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.
Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.
UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.
Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.
Show child attributes
Show child attributes
Available options:
import, export, both Response
200 - application/json
Internal database ID of the element. Assigned by the API; unique per element.
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.
Show child attributes
Show child attributes
Available options:
BUILDING, CLIENT_ACTION_REQUIRED, CONFIGURATION_ERROR, SETUP_FAILED, READY, DISCONNECTING Validation or setup errors when state is not READY.
Show child attributes
Show child attributes
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 set, the element is archived (soft-deleted). Archived elements cannot be patched.
When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).
When true, the element cannot be modified (e.g. published package elements or elements from another workspace).
Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.
UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.
Key of the integration; alternative to integrationId. Resolved to integrationId by the API.
UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.
Key of the parent element; alternative to parentId. Resolved to parentId by the API.
When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.
Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.
UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.
Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.
Show child attributes
Show child attributes
Available options:
import, export, both Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?
⌘I