PATCH
/
core
/
connection
/
{id}
curl --request PATCH \
  --url https://api.openint.dev/v0/core/connection/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-apikey: <api-key>' \
  --header 'x-connection-id: <api-key>' \
  --data '{
  "settings": {},
  "displayName": "<string>",
  "metadata": "<any>",
  "disabled": true,
  "customerId": "<string>",
  "integrationId": "<string>"
}'
{
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "id": "<string>",
  "connectorName": "<string>",
  "displayName": "<string>",
  "customerId": "<string>",
  "connectorConfigId": "<string>",
  "integrationId": "<string>",
  "settings": {},
  "standard": {
    "displayName": "<string>",
    "status": "healthy",
    "statusMessage": "<string>",
    "labels": [
      "<string>"
    ]
  },
  "disabled": true,
  "metadata": "<any>"
}

Authorizations

x-apikey
string
header
required
x-connection-id
string
header
required

Path Parameters

id
string
required

Must start with 'conn_'

Body

application/json
settings
object | null
displayName
string | null
metadata
any

JSON object can can be used to associate arbitrary metadata to avoid needing a separate 1-1 table just for simple key values in your application. During updates this object will be shallowly merged

disabled
boolean
customerId
string | null
Minimum length: 1
integrationId
string | null

Must start with 'int_'

Response

200
application/json
Successful response
createdAt
string
required
updatedAt
string
required
id
string
required

Must start with 'conn_'

connectorName
string
required

Unique name of the connector

connectorConfigId
string
required

Must start with 'ccfg_'

displayName
string | null
customerId
string | null
Minimum length: 1
integrationId
string | null

Must start with 'int_'

settings
object | null
standard
object | null
disabled
boolean
metadata
any

JSON object can can be used to associate arbitrary metadata to avoid needing a separate 1-1 table just for simple key values in your application. During updates this object will be shallowly merged