Update externalConnection

Namespace: microsoft.graph.externalConnectors

Update the properties of an externalConnection object.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet


Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) ExternalConnection.ReadWrite.OwnedBy ExternalConnection.ReadWrite.All
Delegated (personal Microsoft account) Not supported. Not supported.
Application ExternalConnection.ReadWrite.OwnedBy ExternalConnection.ReadWrite.All

HTTP request

PATCH /external/connections/{connectionsId}

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json. Required.

Request body

In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance, don't include existing values that haven't changed. The following properties can be updated.

Property Type Description
configuration microsoft.graph.externalConnectors.configuration Specifies additional application IDs that are allowed to manage the connection and to index content in the connection.
description String Description of the connection displayed in the Microsoft 365 admin center.
name String The display name of the connection to be displayed in the Microsoft 365 admin center. Maximum length of 128 characters.


If successful, this method returns a 204 No Content response code.



PATCH https://graph.microsoft.com/v1.0/external/connections/contosohr
Content-type: application/json

  "name": "Contoso HR Service Tickets",
  "description": "Connection to index HR service tickets"


The following example shows the response.

HTTP/1.1 204 No Content