Skip to main content
PATCH
/
v1
/
connector-instances
/
{connectorInstanceId}
Update connector instance
curl --request PATCH \
  --url https://api.openworklabs.com/v1/connector-instances/{connectorInstanceId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "remoteId": "<string>",
  "name": "<string>",
  "config": {}
}
'
{
  "ok": true,
  "item": {
    "id": "<string>",
    "organizationId": "<string>",
    "connectorAccountId": "<string>",
    "remoteId": "<string>",
    "name": "<string>",
    "instanceConfigJson": {},
    "lastSyncedAt": "2023-11-07T05:31:56Z",
    "lastSyncCursor": "<string>",
    "createdByOrgMembershipId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Documentation Index

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

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

Path Parameters

​
connectorInstanceId
string<typeid>
required

Den TypeID with 'cin_' prefix and a 26-character base32 suffix.

Required string length: 30
Pattern: ^cin_.*

Body

application/json
​
remoteId
string | null
Required string length: 1 - 255
​
name
string
Required string length: 1 - 255
​
status
enum<string>
Available options:
active,
disabled,
archived,
error
​
config
object

Response

Connector instance updated successfully.

​
ok
boolean
required
​
item
object
required