Update connector
Changes the fields you send and returns the full updated document.
Send only the fields you want to change, plus version with the num from your last read and a change_description. This is a JSON merge-patch: a field you leave out keeps its stored value, and every list or map you send replaces the stored one whole. The id goes in the URL; if you also send id in the body it must match.
Authentication
JWT bearer token authentication. Include the Configuration API key in the Authorization header as ‘Bearer <token>’.
Path parameters
The id of the connector, as returned when it was created or listed.
Request
Box (legacy) connection settings, used when system is EXTERNAL_SYSTEM_BOX_LEGACY. Set exactly one system-specific config.
ServiceNow connection settings, used when system is EXTERNAL_SYSTEM_SERVICE_NOW. Set exactly one system-specific config.
Box connection settings, used when system is EXTERNAL_SYSTEM_BOX. Set exactly one system-specific config.
Confluence Cloud connection settings, used when system is EXTERNAL_SYSTEM_CONFLUENCE. Set exactly one system-specific config.
Google Drive connection settings, used when system is EXTERNAL_SYSTEM_GDRIVE. Set exactly one system-specific config.
Jira connection settings, used when system is EXTERNAL_SYSTEM_JIRA. Set exactly one system-specific config.
Microsoft Outlook connection settings, used when system is EXTERNAL_SYSTEM_OUTLOOK. Set exactly one system-specific config.
Slack connection settings, used when system is EXTERNAL_SYSTEM_SLACK. Set exactly one system-specific config.
Unily connection settings, used when system is EXTERNAL_SYSTEM_UNILY. Set exactly one system-specific config.
Zendesk connection settings, used when system is EXTERNAL_SYSTEM_ZENDESK. Set exactly one system-specific config.
SAP Ariba connection settings, used when system is EXTERNAL_SYSTEM_ARIBA. Set exactly one system-specific config.
Amazon Connect connection settings, used when system is EXTERNAL_SYSTEM_AMAZON_CONNECT. Set exactly one system-specific config.
AuthHub connection settings, used when system is EXTERNAL_SYSTEM_AUTHHUB. Set exactly one system-specific config.
Axero connection settings, used when system is EXTERNAL_SYSTEM_AXERO. Set exactly one system-specific config.
Backstage connection settings, used when system is EXTERNAL_SYSTEM_BACKSTAGE. Set exactly one system-specific config.
BeyondTrust connection settings, used when system is EXTERNAL_SYSTEM_BEYOND_TRUST. Set exactly one system-specific config.
BMC Remedy (including Remedy Helix) connection settings, used when system is EXTERNAL_SYSTEM_BMC_REMEDY. Set exactly one system-specific config.
BMC Remedy DWP connection settings, used when system is EXTERNAL_SYSTEM_BMC_REMEDY_DWP. Set exactly one system-specific config.
BMC Remedyforce connection settings, used when system is EXTERNAL_SYSTEM_BMC_REMEDYFORCE. Set exactly one system-specific config.
Brainstorm connection settings, used when system is EXTERNAL_SYSTEM_BRAINSTORM. Set exactly one system-specific config.
Brightspot connection settings, used when system is EXTERNAL_SYSTEM_BRIGHTSPOT. Set exactly one system-specific config.
Cherwell connection settings, used when system is EXTERNAL_SYSTEM_CHERWELL. Set exactly one system-specific config.
ComAround connection settings, used when system is EXTERNAL_SYSTEM_COMAROUND. Set exactly one system-specific config.
SAP Concur connection settings, used when system is EXTERNAL_SYSTEM_CONCUR. Set exactly one system-specific config.
Confluence (legacy) connection settings, used when system is EXTERNAL_SYSTEM_CONFLUENCE_LEGACY. Set exactly one system-specific config.
Confluence Server connection settings, used when system is EXTERNAL_SYSTEM_CONFLUENCE_SERVER. Set exactly one system-specific config.
ConnectWise connection settings, used when system is EXTERNAL_SYSTEM_CONNECT_WISE. Set exactly one system-specific config.
Contentful connection settings, used when system is EXTERNAL_SYSTEM_CONTENTFUL. Set exactly one system-specific config.
Coupa connection settings, used when system is EXTERNAL_SYSTEM_COUPA. Set exactly one system-specific config.
Dovetail connection settings, used when system is EXTERNAL_SYSTEM_DOVETAIL. Set exactly one system-specific config.
Dropbox connection settings, used when system is EXTERNAL_SYSTEM_DROPBOX. Set exactly one system-specific config.
Duo connection settings, used when system is EXTERNAL_SYSTEM_DUO. Set exactly one system-specific config.
8x8 connection settings, used when system is EXTERNAL_SYSTEM_EIGHT_X_EIGHT. Set exactly one system-specific config.
Microsoft Exchange Online connection settings, used when system is EXTERNAL_SYSTEM_EXCHANGE. Set exactly one system-specific config.
SAP Fieldglass connection settings, used when system is EXTERNAL_SYSTEM_FIELDGLASS. Set exactly one system-specific config.
Five9 connection settings, used when system is EXTERNAL_SYSTEM_FIVE_NINE. Set exactly one system-specific config.
Freshchat connection settings, used when system is EXTERNAL_SYSTEM_FRESH_CHAT. Set exactly one system-specific config.
Freshdesk connection settings, used when system is EXTERNAL_SYSTEM_FRESH_DESK. Set exactly one system-specific config.
Freshservice connection settings, used when system is EXTERNAL_SYSTEM_FRESH_SERVICE. Set exactly one system-specific config.
Google Drive (legacy) connection settings, used when system is EXTERNAL_SYSTEM_GDRIVE_LEGACY. Set exactly one system-specific config.
Genesys connection settings, used when system is EXTERNAL_SYSTEM_GENESYS. Set exactly one system-specific config.
GitHub connection settings, used when system is EXTERNAL_SYSTEM_GITHUB. Set exactly one system-specific config.
Glia connection settings, used when system is EXTERNAL_SYSTEM_GLIA. Set exactly one system-specific config.
Google Workspace (G Suite) connection settings, used when system is EXTERNAL_SYSTEM_GSUITE. Set exactly one system-specific config.
Guru connection settings, used when system is EXTERNAL_SYSTEM_GURU. Set exactly one system-specific config.
Igloo connection settings, used when system is EXTERNAL_SYSTEM_IGLOO. Set exactly one system-specific config.
Interact connection settings, used when system is EXTERNAL_SYSTEM_INTERACT. Set exactly one system-specific config.
Ivanti connection settings, used when system is EXTERNAL_SYSTEM_IVANTI. Set exactly one system-specific config.
Jira (legacy) connection settings, used when system is EXTERNAL_SYSTEM_JIRA_LEGACY. Set exactly one system-specific config.
Jive connection settings, used when system is EXTERNAL_SYSTEM_JIVE. Set exactly one system-specific config.
LumApps connection settings, used when system is EXTERNAL_SYSTEM_LUMAPPS. Set exactly one system-specific config.
ManageEngine ServiceDesk connection settings, used when system is EXTERNAL_SYSTEM_MANAGE_ENGINE. Set exactly one system-specific config.
Meta Workplace connection settings, used when system is EXTERNAL_SYSTEM_META_WORKPLACE. Set exactly one system-specific config.
Microsoft Dynamics connection settings, used when system is EXTERNAL_SYSTEM_MICROSOFT_DYNAMICS. Set exactly one system-specific config.
Microsoft Graph connection settings, used when system is EXTERNAL_SYSTEM_MS_GRAPH. Set exactly one system-specific config.
Microsoft Teams organization connection settings, used when system is EXTERNAL_SYSTEM_MS_TEAMS_ORG. Set exactly one system-specific config.
Notion connection settings, used when system is EXTERNAL_SYSTEM_NOTION. Set exactly one system-specific config.
OfficeSpace connection settings, used when system is EXTERNAL_SYSTEM_OFFICESPACE. Set exactly one system-specific config.
Okta connection settings, used when system is EXTERNAL_SYSTEM_OKTA. Set exactly one system-specific config.
OneLogin connection settings, used when system is EXTERNAL_SYSTEM_ONELOGIN. Set exactly one system-specific config.
Oracle connection settings, used when system is EXTERNAL_SYSTEM_ORACLE. Set exactly one system-specific config.
PingID connection settings, used when system is EXTERNAL_SYSTEM_PING. Set exactly one system-specific config.
Promapp connection settings, used when system is EXTERNAL_SYSTEM_PROMAPP. Set exactly one system-specific config.
Quip connection settings, used when system is EXTERNAL_SYSTEM_QUIP. Set exactly one system-specific config.
RightAnswers connection settings, used when system is EXTERNAL_SYSTEM_RIGHT_ANSWERS. Set exactly one system-specific config.
SailPoint IdentityIQ connection settings, used when system is EXTERNAL_SYSTEM_SAILPOINT. Set exactly one system-specific config.
SailPoint Identity Security Cloud connection settings, used when system is EXTERNAL_SYSTEM_SAILPOINT_INOW. Set exactly one system-specific config.
Salesforce Service Cloud connection settings, used when system is EXTERNAL_SYSTEM_SALESFORCE. Set exactly one system-specific config.
ScreenSteps connection settings, used when system is EXTERNAL_SYSTEM_SCREEN_STEPS. Set exactly one system-specific config.
SearchUnify connection settings, used when system is EXTERNAL_SYSTEM_SEARCHUNIFY. Set exactly one system-specific config.
Simpplr connection settings, used when system is EXTERNAL_SYSTEM_SIMPPLR. Set exactly one system-specific config.
Simpplr One connection settings, used when system is EXTERNAL_SYSTEM_SIMPPLR_ONE. Set exactly one system-specific config.
Slack (legacy) connection settings, used when system is EXTERNAL_SYSTEM_SLACK_LEGACY. Set exactly one system-specific config.
Slite connection settings, used when system is EXTERNAL_SYSTEM_SLITE. Set exactly one system-specific config.
SolarWinds connection settings, used when system is EXTERNAL_SYSTEM_SOLARWINDS. Set exactly one system-specific config.
Squiz connection settings, used when system is EXTERNAL_SYSTEM_SQUIZ. Set exactly one system-specific config.
Staffbase connection settings, used when system is EXTERNAL_SYSTEM_STAFFBASE. Set exactly one system-specific config.
Symphony connection settings, used when system is EXTERNAL_SYSTEM_SYMPHONY. Set exactly one system-specific config.
SysAid connection settings, used when system is EXTERNAL_SYSTEM_SYSAID. Set exactly one system-specific config.
Unily (legacy) connection settings, used when system is EXTERNAL_SYSTEM_UNILY_LEGACY. Set exactly one system-specific config.
Wiki.js connection settings, used when system is EXTERNAL_SYSTEM_WIKIJS. Set exactly one system-specific config.
Wolken connection settings, used when system is EXTERNAL_SYSTEM_WOLKEN. Set exactly one system-specific config.
WordPress connection settings, used when system is EXTERNAL_SYSTEM_WORDPRESS. Set exactly one system-specific config.
SAP Work Zone connection settings, used when system is EXTERNAL_SYSTEM_WORK_ZONE. Set exactly one system-specific config.
Workday connection settings, used when system is EXTERNAL_SYSTEM_WORKDAY. Set exactly one system-specific config.
Zendesk (legacy) connection settings, used when system is EXTERNAL_SYSTEM_ZENDESK_LEGACY. Set exactly one system-specific config.
Zoom connection settings, used when system is EXTERNAL_SYSTEM_ZOOM. Set exactly one system-specific config.
Content Gateway System connection settings, used when system is EXTERNAL_SYSTEM_CONTENT_GATEWAY_SYSTEM. Set exactly one system-specific config.
Response
External system this connector connects to. Determines which system-specific config must be set. Cannot be changed after creation.
Box (legacy) connection settings, used when system is EXTERNAL_SYSTEM_BOX_LEGACY. Set exactly one system-specific config.
ServiceNow connection settings, used when system is EXTERNAL_SYSTEM_SERVICE_NOW. Set exactly one system-specific config.
Box connection settings, used when system is EXTERNAL_SYSTEM_BOX. Set exactly one system-specific config.
Confluence Cloud connection settings, used when system is EXTERNAL_SYSTEM_CONFLUENCE. Set exactly one system-specific config.
Google Drive connection settings, used when system is EXTERNAL_SYSTEM_GDRIVE. Set exactly one system-specific config.
Jira connection settings, used when system is EXTERNAL_SYSTEM_JIRA. Set exactly one system-specific config.
Microsoft Outlook connection settings, used when system is EXTERNAL_SYSTEM_OUTLOOK. Set exactly one system-specific config.
Slack connection settings, used when system is EXTERNAL_SYSTEM_SLACK. Set exactly one system-specific config.
Unily connection settings, used when system is EXTERNAL_SYSTEM_UNILY. Set exactly one system-specific config.
Zendesk connection settings, used when system is EXTERNAL_SYSTEM_ZENDESK. Set exactly one system-specific config.
SAP Ariba connection settings, used when system is EXTERNAL_SYSTEM_ARIBA. Set exactly one system-specific config.
Amazon Connect connection settings, used when system is EXTERNAL_SYSTEM_AMAZON_CONNECT. Set exactly one system-specific config.
AuthHub connection settings, used when system is EXTERNAL_SYSTEM_AUTHHUB. Set exactly one system-specific config.
Axero connection settings, used when system is EXTERNAL_SYSTEM_AXERO. Set exactly one system-specific config.
Backstage connection settings, used when system is EXTERNAL_SYSTEM_BACKSTAGE. Set exactly one system-specific config.
BeyondTrust connection settings, used when system is EXTERNAL_SYSTEM_BEYOND_TRUST. Set exactly one system-specific config.
BMC Remedy (including Remedy Helix) connection settings, used when system is EXTERNAL_SYSTEM_BMC_REMEDY. Set exactly one system-specific config.
BMC Remedy DWP connection settings, used when system is EXTERNAL_SYSTEM_BMC_REMEDY_DWP. Set exactly one system-specific config.
BMC Remedyforce connection settings, used when system is EXTERNAL_SYSTEM_BMC_REMEDYFORCE. Set exactly one system-specific config.
Brainstorm connection settings, used when system is EXTERNAL_SYSTEM_BRAINSTORM. Set exactly one system-specific config.
Brightspot connection settings, used when system is EXTERNAL_SYSTEM_BRIGHTSPOT. Set exactly one system-specific config.
Cherwell connection settings, used when system is EXTERNAL_SYSTEM_CHERWELL. Set exactly one system-specific config.
ComAround connection settings, used when system is EXTERNAL_SYSTEM_COMAROUND. Set exactly one system-specific config.
SAP Concur connection settings, used when system is EXTERNAL_SYSTEM_CONCUR. Set exactly one system-specific config.
Confluence (legacy) connection settings, used when system is EXTERNAL_SYSTEM_CONFLUENCE_LEGACY. Set exactly one system-specific config.
Confluence Server connection settings, used when system is EXTERNAL_SYSTEM_CONFLUENCE_SERVER. Set exactly one system-specific config.
ConnectWise connection settings, used when system is EXTERNAL_SYSTEM_CONNECT_WISE. Set exactly one system-specific config.
Contentful connection settings, used when system is EXTERNAL_SYSTEM_CONTENTFUL. Set exactly one system-specific config.
Coupa connection settings, used when system is EXTERNAL_SYSTEM_COUPA. Set exactly one system-specific config.
Dovetail connection settings, used when system is EXTERNAL_SYSTEM_DOVETAIL. Set exactly one system-specific config.
Dropbox connection settings, used when system is EXTERNAL_SYSTEM_DROPBOX. Set exactly one system-specific config.
Duo connection settings, used when system is EXTERNAL_SYSTEM_DUO. Set exactly one system-specific config.
8x8 connection settings, used when system is EXTERNAL_SYSTEM_EIGHT_X_EIGHT. Set exactly one system-specific config.
Microsoft Exchange Online connection settings, used when system is EXTERNAL_SYSTEM_EXCHANGE. Set exactly one system-specific config.
SAP Fieldglass connection settings, used when system is EXTERNAL_SYSTEM_FIELDGLASS. Set exactly one system-specific config.
Five9 connection settings, used when system is EXTERNAL_SYSTEM_FIVE_NINE. Set exactly one system-specific config.
Freshchat connection settings, used when system is EXTERNAL_SYSTEM_FRESH_CHAT. Set exactly one system-specific config.
Freshdesk connection settings, used when system is EXTERNAL_SYSTEM_FRESH_DESK. Set exactly one system-specific config.
Freshservice connection settings, used when system is EXTERNAL_SYSTEM_FRESH_SERVICE. Set exactly one system-specific config.
Google Drive (legacy) connection settings, used when system is EXTERNAL_SYSTEM_GDRIVE_LEGACY. Set exactly one system-specific config.
Genesys connection settings, used when system is EXTERNAL_SYSTEM_GENESYS. Set exactly one system-specific config.
GitHub connection settings, used when system is EXTERNAL_SYSTEM_GITHUB. Set exactly one system-specific config.
Glia connection settings, used when system is EXTERNAL_SYSTEM_GLIA. Set exactly one system-specific config.
Google Workspace (G Suite) connection settings, used when system is EXTERNAL_SYSTEM_GSUITE. Set exactly one system-specific config.
Guru connection settings, used when system is EXTERNAL_SYSTEM_GURU. Set exactly one system-specific config.
Igloo connection settings, used when system is EXTERNAL_SYSTEM_IGLOO. Set exactly one system-specific config.
Interact connection settings, used when system is EXTERNAL_SYSTEM_INTERACT. Set exactly one system-specific config.
Ivanti connection settings, used when system is EXTERNAL_SYSTEM_IVANTI. Set exactly one system-specific config.
Jira (legacy) connection settings, used when system is EXTERNAL_SYSTEM_JIRA_LEGACY. Set exactly one system-specific config.
Jive connection settings, used when system is EXTERNAL_SYSTEM_JIVE. Set exactly one system-specific config.
LumApps connection settings, used when system is EXTERNAL_SYSTEM_LUMAPPS. Set exactly one system-specific config.
ManageEngine ServiceDesk connection settings, used when system is EXTERNAL_SYSTEM_MANAGE_ENGINE. Set exactly one system-specific config.
Meta Workplace connection settings, used when system is EXTERNAL_SYSTEM_META_WORKPLACE. Set exactly one system-specific config.
Microsoft Dynamics connection settings, used when system is EXTERNAL_SYSTEM_MICROSOFT_DYNAMICS. Set exactly one system-specific config.
Microsoft Graph connection settings, used when system is EXTERNAL_SYSTEM_MS_GRAPH. Set exactly one system-specific config.
Microsoft Teams organization connection settings, used when system is EXTERNAL_SYSTEM_MS_TEAMS_ORG. Set exactly one system-specific config.
Notion connection settings, used when system is EXTERNAL_SYSTEM_NOTION. Set exactly one system-specific config.
OfficeSpace connection settings, used when system is EXTERNAL_SYSTEM_OFFICESPACE. Set exactly one system-specific config.
Okta connection settings, used when system is EXTERNAL_SYSTEM_OKTA. Set exactly one system-specific config.
OneLogin connection settings, used when system is EXTERNAL_SYSTEM_ONELOGIN. Set exactly one system-specific config.
Oracle connection settings, used when system is EXTERNAL_SYSTEM_ORACLE. Set exactly one system-specific config.
PingID connection settings, used when system is EXTERNAL_SYSTEM_PING. Set exactly one system-specific config.
Promapp connection settings, used when system is EXTERNAL_SYSTEM_PROMAPP. Set exactly one system-specific config.
Quip connection settings, used when system is EXTERNAL_SYSTEM_QUIP. Set exactly one system-specific config.
RightAnswers connection settings, used when system is EXTERNAL_SYSTEM_RIGHT_ANSWERS. Set exactly one system-specific config.
SailPoint IdentityIQ connection settings, used when system is EXTERNAL_SYSTEM_SAILPOINT. Set exactly one system-specific config.
SailPoint Identity Security Cloud connection settings, used when system is EXTERNAL_SYSTEM_SAILPOINT_INOW. Set exactly one system-specific config.
Salesforce Service Cloud connection settings, used when system is EXTERNAL_SYSTEM_SALESFORCE. Set exactly one system-specific config.
ScreenSteps connection settings, used when system is EXTERNAL_SYSTEM_SCREEN_STEPS. Set exactly one system-specific config.
SearchUnify connection settings, used when system is EXTERNAL_SYSTEM_SEARCHUNIFY. Set exactly one system-specific config.
Simpplr connection settings, used when system is EXTERNAL_SYSTEM_SIMPPLR. Set exactly one system-specific config.
Simpplr One connection settings, used when system is EXTERNAL_SYSTEM_SIMPPLR_ONE. Set exactly one system-specific config.
Slack (legacy) connection settings, used when system is EXTERNAL_SYSTEM_SLACK_LEGACY. Set exactly one system-specific config.
Slite connection settings, used when system is EXTERNAL_SYSTEM_SLITE. Set exactly one system-specific config.
SolarWinds connection settings, used when system is EXTERNAL_SYSTEM_SOLARWINDS. Set exactly one system-specific config.
Squiz connection settings, used when system is EXTERNAL_SYSTEM_SQUIZ. Set exactly one system-specific config.
Staffbase connection settings, used when system is EXTERNAL_SYSTEM_STAFFBASE. Set exactly one system-specific config.
Symphony connection settings, used when system is EXTERNAL_SYSTEM_SYMPHONY. Set exactly one system-specific config.
SysAid connection settings, used when system is EXTERNAL_SYSTEM_SYSAID. Set exactly one system-specific config.
Unily (legacy) connection settings, used when system is EXTERNAL_SYSTEM_UNILY_LEGACY. Set exactly one system-specific config.
Wiki.js connection settings, used when system is EXTERNAL_SYSTEM_WIKIJS. Set exactly one system-specific config.
Wolken connection settings, used when system is EXTERNAL_SYSTEM_WOLKEN. Set exactly one system-specific config.
WordPress connection settings, used when system is EXTERNAL_SYSTEM_WORDPRESS. Set exactly one system-specific config.
SAP Work Zone connection settings, used when system is EXTERNAL_SYSTEM_WORK_ZONE. Set exactly one system-specific config.
Workday connection settings, used when system is EXTERNAL_SYSTEM_WORKDAY. Set exactly one system-specific config.
Zendesk (legacy) connection settings, used when system is EXTERNAL_SYSTEM_ZENDESK_LEGACY. Set exactly one system-specific config.
Zoom connection settings, used when system is EXTERNAL_SYSTEM_ZOOM. Set exactly one system-specific config.
Content Gateway System connection settings, used when system is EXTERNAL_SYSTEM_CONTENT_GATEWAY_SYSTEM. Set exactly one system-specific config.