Sign in
Connectors (Integrations)

Update a connector

Update the connector for the specified provider.

When you make a PATCH request, Nylas replaces all data in the nested object with the information included in your request. For more information, see Updating objects.

patch/v3/connectors/{provider}

Path parameters

provider'google' | 'microsoft' | 'imap' | 'icloud' | 'yahoo' | 'ews' | 'virtual-calendar' | 'zoom' | 'nylas' required
Example:google

Request body

settingsobject

Oauth provider credentials and settings

scopestring[]

Oauth "scope" parameter

active_credential_idstring

(Optional) The ID of the "default" credential record of this Connector. This credential will be used as a default for communication with the provider.

Example request

{
  "settings": {
    "tenant": "common"
  },
  "scope": [
    "Mail.Read",
    "User.Read",
    "offline_access"
  ],
  "active_credential_id": "c123f8e1a-eb1c-41c0-b6a6-d2e59daf7f47"
}

Response

Returns the connector object (previously called an integration) for the provider you specify.

request_idstring

ID of the request

Example response

{
  "request_id": "5967ca40-a2d8-4ee0-a0e0-6f18ace39a90",
  "data": {
    "name": "Google Connector",
    "provider": "google",
    "settings": {
      "topic_name": "abc123"
    },
    "scope": [
      "https://www.googleapis.com/auth/userinfo.email",
      "https://www.googleapis.com/auth/userinfo.profile"
    ],
    "active_credential_id": "c123f8e1a-eb1c-41c0-b6a6-d2e59daf7f47"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.