title	notebook: copyNotebook
description	Copies a notebook to the Notebooks folder in the destination Documents library. The folder is created if it doesn't exist.
ms.localizationpriority	medium
author	jewan-microsoft
ms.subservice	onenote
doc_type	apiPageType
ms.date	06/22/2024

notebook: copyNotebook

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

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.

[!INCLUDE national-cloud-support]

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.

[!INCLUDE permissions-table]

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.

HTTP

POST https://graph.microsoft.com/beta/me/onenote/notebooks/{id}/copyNotebook
Content-type: application/json

{
  "groupId": "groupId-value",
  "renameAs": "renameAs-value"
}