notebook: copyNotebook
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.
Copies a notebook to the Notebooks folder in the destination Documents library. The folder is created if it doesn't exist.
For Copy operations, you follow an asynchronous calling pattern: First call the Copy action, and then poll the operation endpoint for the result.
This API is available in the following national cloud deployments.
Global service | US Government L4 | US Government L5 (DOD) | China operated by 21Vianet |
---|---|---|---|
✅ | ❌ | ❌ | ❌ |
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 permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | Notes.Create | Notes.ReadWrite, Notes.ReadWrite.All |
Delegated (personal Microsoft account) | Notes.Create | Notes.ReadWrite |
Application | Notes.ReadWrite.All | Not available. |
HTTP request
POST /me/onenote/notebooks/{id}/copyNotebook
POST /users/{id | userPrincipalName}/onenote/notebooks/{id}/copyNotebook
POST /groups/{id}/onenote/notebooks/{id}/copyNotebook
POST /sites/{id}/onenote/notebooks/{id}/copyNotebook
Request headers
Name | Type | Description |
---|---|---|
Authorization | string | Bearer {token}. Required. Learn more about authentication and authorization. |
Content-Type | string | application/json |
Request body
In the request body, provide a JSON object that contains the parameters that your operation needs. It's okay to send an empty body if none is needed.
Parameter | Type | Description |
---|---|---|
siteCollectionId | String | The id of the SharePoint site to copy to. Use only when copying to a SharePoint site. |
siteId | String | The id of the SharePoint web to copy to. Use only when copying to a SharePoint site. |
groupId | String | The id of the group to copy to. Use only when copying to a Microsoft 365 group. |
renameAs | String | The name of the copy. Defaults to the name of the existing item. |
Response
If successful, this method returns a 202 Accepted
response code and an Operation-Location
header. Poll the Operation-Location endpoint to get the status of the copy operation.
Example
Here's an example of how to call this API.
Request
The following example shows a request.
POST https://graph.microsoft.com/beta/me/onenote/notebooks/{id}/copyNotebook
Content-type: application/json
{
"groupId": "groupId-value",
"renameAs": "renameAs-value"
}
Response
The following example shows the response.
HTTP/1.1 202 Accepted
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for