API referenceConnectors

Update connector

Rename a connector. Another connector of the same integration and method with this name answers 409. A workspace without several connections per integration answers 403.

PATCH

/v1/connectors/{id}

PATCH

/connectors/{id}

curl -X PATCH "https://api.corma.io/v1/connectors/{id}" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string"
}'

Authorization

x-corma-api-key
string
header
required
Colon-separated API key ID and secret: API_KEY_ID:API_KEY_SECRET

Parameters

id
string
path
required
The identifier of the connector, as GET /connectors returned it. The legacy kind.method form stays accepted while the workspace holds one connection of that integration; with several, it answers 409.
x-corma-idempotency-key
string
header
Optional client-generated key. Reusing the same key with an identical request replays the original response instead of enqueueing a duplicate task.
x-corma-workspace-ids
string
header
Optional workspace id. Absent, the route serves the workspace of the credential. An API key can only name its own workspace. A bearer token can name a workspace where its person is an admin member.

Body

application/json

name
string
required
The new name of the connection. Another connection of the same integration and method cannot have it.

Response

application/json200

id
string
required
Opaque identifier of the connector. Treat it as a string: pass back the value the API returned, and do not build it or parse it. The legacy kind.method form stays accepted on input while the workspace holds one connection of that integration.
kind
enum<string>
required
The integration this connector connects to.
One of:
google
microsoft
okta
onelogin
pennylane
spendesk
qonto
candis
agicap
payhawk
slack
lastpass
onepassword
github
atlassian
notion
miro
hubspot
salesforce
aircall
zendesk
deskpro
intercom
linear
figma
front
adobe
asana
dashlane
modjo
aws
dropbox
openai
docusign
datadog
deel
freshservice
freshdesk
freshcaller
canva
gong
zoho
cloudflare
calendly
diabolocom
jamf
cursor
quable
quableportal
gitlab
udemy
amplitude
zoom
autodesk_bim_360
jumpcloud
claude_ai
claude_platform
bitwarden
clickup
make
brevo
yousign
leexi
posthog
odoo
eurecia
ringover
rippling
akuiteo
yooz
snowflake
personio
coda
merge_factorial
bamboohr
payfit
lucca
yoobic
tableau
monday
chatgpt
fxbo
siit
airtable
voiso
moss
hibob
tomorro
factorial
kelio
workday
silae
claap
sentry
malibou
leapsome
metabase
method
enum<string>
required
How Corma reaches the integration.
One of:
api
agent
nango
name
string
required
The name of the integration, as Corma displays it. The name of this connection is connectionName.
connectionName
string | null
required
The name the workspace gave this connection. Null until it is named.
logoUrl
string<uri> | null
required
The logo of the connector. Null when Corma has none.
connectedAt
string<date-time> | null
required
The timestamp of when the workspace connected this connector. ISO 8601 format. Null when the connection holds no credentials.

{
  "id": "string",
  "kind": "google",
  "method": "api",
  "name": "string",
  "connectionName": "string",
  "logoUrl": "https://example.com",
  "connectedAt": "2026-01-15T09:30:00Z"
}

PATCH

/connectors/{id}

curl -X PATCH "https://api.corma.io/v1/connectors/{id}" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string"
}'

{
  "id": "string",
  "kind": "google",
  "method": "api",
  "name": "string",
  "connectionName": "string",
  "logoUrl": "https://example.com",
  "connectedAt": "2026-01-15T09:30:00Z"
}

Update connector - Corma Help Center | Productlane

API referenceConnectors

Update connector

Rename a connector. Another connector of the same integration and method with this name answers 409. A workspace without several connections per integration answers 403.

PATCH

/v1/connectors/{id}

PATCH

/connectors/{id}

curl -X PATCH "https://api.corma.io/v1/connectors/{id}" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string"
}'

Authorization

x-corma-api-key
string
header
required
Colon-separated API key ID and secret: API_KEY_ID:API_KEY_SECRET

Parameters

id
string
path
required
The identifier of the connector, as GET /connectors returned it. The legacy kind.method form stays accepted while the workspace holds one connection of that integration; with several, it answers 409.
x-corma-idempotency-key
string
header
Optional client-generated key. Reusing the same key with an identical request replays the original response instead of enqueueing a duplicate task.
x-corma-workspace-ids
string
header
Optional workspace id. Absent, the route serves the workspace of the credential. An API key can only name its own workspace. A bearer token can name a workspace where its person is an admin member.

Body

application/json

name
string
required
The new name of the connection. Another connection of the same integration and method cannot have it.

Response

application/json200

id
string
required
Opaque identifier of the connector. Treat it as a string: pass back the value the API returned, and do not build it or parse it. The legacy kind.method form stays accepted on input while the workspace holds one connection of that integration.
kind
enum<string>
required
The integration this connector connects to.
One of:
google
microsoft
okta
onelogin
pennylane
spendesk
qonto
candis
agicap
payhawk
slack
lastpass
onepassword
github
atlassian
notion
miro
hubspot
salesforce
aircall
zendesk
deskpro
intercom
linear
figma
front
adobe
asana
dashlane
modjo
aws
dropbox
openai
docusign
datadog
deel
freshservice
freshdesk
freshcaller
canva
gong
zoho
cloudflare
calendly
diabolocom
jamf
cursor
quable
quableportal
gitlab
udemy
amplitude
zoom
autodesk_bim_360
jumpcloud
claude_ai
claude_platform
bitwarden
clickup
make
brevo
yousign
leexi
posthog
odoo
eurecia
ringover
rippling
akuiteo
yooz
snowflake
personio
coda
merge_factorial
bamboohr
payfit
lucca
yoobic
tableau
monday
chatgpt
fxbo
siit
airtable
voiso
moss
hibob
tomorro
factorial
kelio
workday
silae
claap
sentry
malibou
leapsome
metabase
method
enum<string>
required
How Corma reaches the integration.
One of:
api
agent
nango
name
string
required
The name of the integration, as Corma displays it. The name of this connection is connectionName.
connectionName
string | null
required
The name the workspace gave this connection. Null until it is named.
logoUrl
string<uri> | null
required
The logo of the connector. Null when Corma has none.
connectedAt
string<date-time> | null
required
The timestamp of when the workspace connected this connector. ISO 8601 format. Null when the connection holds no credentials.

{
  "id": "string",
  "kind": "google",
  "method": "api",
  "name": "string",
  "connectionName": "string",
  "logoUrl": "https://example.com",
  "connectedAt": "2026-01-15T09:30:00Z"
}

PATCH

/connectors/{id}

curl -X PATCH "https://api.corma.io/v1/connectors/{id}" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string"
}'

{
  "id": "string",
  "kind": "google",
  "method": "api",
  "name": "string",
  "connectionName": "string",
  "logoUrl": "https://example.com",
  "connectedAt": "2026-01-15T09:30:00Z"
}