Update planContextLink

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Update the properties of a planContextLink object.

Permissions

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 permission	Higher privileged permissions
Delegated (work or school account)	Not supported.	Not supported.
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	Not supported.	Not supported.

HTTP request

PATCH /me/planner/plans_v2/{planId}/contexts/{planContextLinkId}
PATCH /users/{usersId}/planner/plans_v2/{planId}/contexts/{planContextLinkId}

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 only the values for properties to update. Existing properties that aren't included in the request body maintain their previous values or are recalculated based on changes to other property values.

The following table specifies the properties that can be updated.

Property	Type	Description
key	String	Identifier for the context the plan is surfaced in. Optional.
displayNameSegments	String collection	Display name segments used to render where the plan is surfaced. Optional.
webUrl	String	URL of the surface where the plan is displayed. Optional.
associationType	String	Describes how the plan is associated with the surface. Optional.
displayAs	plannerPlanContextType	How the context link should be displayed. The possible values are: teamsTab, sharePointPage, meetingNotes, other, unknownFutureValue, loopPage, project. Use the Prefer: include-unknown-enum-members request header to get the following values from this evolvable enum: loopPage , project. Optional.
isActive	Boolean	Indicates whether the context link is currently active. Optional.
customLinkText	String	Custom text used to render the link, if provided. Optional.
ownerAppId	String	Application ID of the app that owns the surface the plan is linked from. Optional.
isCreation	Boolean	Indicates whether this context link represents the original creation surface for the plan. Optional.

Response

If successful, this method returns a 200 OK response code and an updated planContextLink object in the response body.

Examples

Request

The following example shows a request.

PATCH https://graph.microsoft.com/beta/me/planner/plans_v2/{planId}/contexts/{planContextLinkId}
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.planContextLink",
  "key": "19:abcdef1234567890abcdef1234567890@thread.tacv2",
  "displayNameSegments": [
    "Contoso Project"
  ],
  "webUrl": "https://teams.microsoft.com/l/entity/com.microsoft.teamspace.tab.planner/tab-contoso-project",
  "associationType": "primary",
  "displayAs": "teamsTab",
  "isActive": true,
  "customLinkText": "Project plan",
  "ownerAppId": "4d1c9a3e-7b52-4f8a-9d31-6c2e8f4b9a17",
  "isCreation": true
}

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.planContextLink",
  "id": "901187ee-a684-eeaa-61d0-b0fb4774cdab",
  "key": "String",
  "displayNameSegments": [
    "String"
  ],
  "webUrl": "String",
  "associationType": "String",
  "displayAs": "String",
  "isActive": "Boolean",
  "customLinkText": "String",
  "ownerAppId": "String",
  "isCreation": "Boolean",
  "createdDateTime": "String (timestamp)"
}