Namespace: microsoft.graph
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
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 are needed.
| Parameter |
Type |
Description |
| 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 is an example of how to call this API.
Request
The following example shows a request.
POST https://graph.microsoft.com/v1.0/me/onenote/notebooks/{id}/copyNotebook
Content-type: application/json
{
"groupId": "groupId-value",
"renameAs": "renameAs-value"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Me.Onenote.Notebooks.Item.CopyNotebook;
var requestBody = new CopyNotebookPostRequestBody
{
GroupId = "groupId-value",
RenameAs = "renameAs-value",
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Me.Onenote.Notebooks["{notebook-id}"].CopyNotebook.PostAsync(requestBody);
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
mgc users onenote notebooks copy-notebook post --user-id {user-id} --notebook-id {notebook-id} --body '{\
"groupId": "groupId-value",\
"renameAs": "renameAs-value"\
}\
'
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
// Code snippets are only available for the latest major version. Current major version is $v1.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
graphusers "github.com/microsoftgraph/msgraph-sdk-go/users"
//other-imports
)
requestBody := graphusers.NewItemCopyNotebookPostRequestBody()
groupId := "groupId-value"
requestBody.SetGroupId(&groupId)
renameAs := "renameAs-value"
requestBody.SetRenameAs(&renameAs)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
copyNotebook, err := graphClient.Me().Onenote().Notebooks().ByNotebookId("notebook-id").CopyNotebook().Post(context.Background(), requestBody, nil)
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.users.item.onenote.notebooks.item.copynotebook.CopyNotebookPostRequestBody copyNotebookPostRequestBody = new com.microsoft.graph.users.item.onenote.notebooks.item.copynotebook.CopyNotebookPostRequestBody();
copyNotebookPostRequestBody.setGroupId("groupId-value");
copyNotebookPostRequestBody.setRenameAs("renameAs-value");
var result = graphClient.me().onenote().notebooks().byNotebookId("{notebook-id}").copyNotebook().post(copyNotebookPostRequestBody);
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
const options = {
authProvider,
};
const client = Client.init(options);
const onenoteOperation = {
groupId: 'groupId-value',
renameAs: 'renameAs-value'
};
await client.api('/me/onenote/notebooks/{id}/copyNotebook')
.post(onenoteOperation);
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Users\Item\Onenote\Notebooks\Item\CopyNotebook\CopyNotebookPostRequestBody;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new CopyNotebookPostRequestBody();
$requestBody->setGroupId('groupId-value');
$requestBody->setRenameAs('renameAs-value');
$result = $graphServiceClient->me()->onenote()->notebooks()->byNotebookId('notebook-id')->copyNotebook()->post($requestBody)->wait();
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
Import-Module Microsoft.Graph.Notes
$params = @{
groupId = "groupId-value"
renameAs = "renameAs-value"
}
# A UPN can also be used as -UserId.
Copy-MgUserOnenoteNotebook -UserId $userId -NotebookId $notebookId -BodyParameter $params
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.users.item.onenote.notebooks.item.copy_notebook.copy_notebook_post_request_body import CopyNotebookPostRequestBody
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = CopyNotebookPostRequestBody(
group_id = "groupId-value",
rename_as = "renameAs-value",
)
result = await graph_client.me.onenote.notebooks.by_notebook_id('notebook-id').copy_notebook.post(request_body)
For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.
Response
The following example shows the response.
HTTP/1.1 202 Accepted