Create notebook

• 5/4/2019
• 2 minutes to read
• Contributors
  • 
  • 
  • 
  • 
  • 
  • all

Create a new OneNote notebook.

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

HTTP request

POST /me/onenote/notebooks
POST /users/{id | userPrincipalName}/onenote/notebooks
POST /groups/{id}/onenote/notebooks
POST /sites/{id}/onenote/notebooks

Request headers

Request body

In the request body, supply a name for the notebook.

Notebook names must be unique. The name cannot contain more than 128 characters or contain the following characters: ?*/:<>|'"

Response

If successful, this method returns a 201 Created response code and the new notebook object in the response body.

Example

Request

Here is an example of the request.

POST https://graph.microsoft.com/beta/me/onenote/notebooks
Content-type: application/json
Content-length: 30

{
  "displayName": "Notebook name"
}

Response

Here is an example of the response. Note: The response object shown here is truncated for brevity. All of the properties will be returned from an actual call.

HTTP/1.1 201 Created
Content-type: application/json
Content-length: 284

{
  "isDefault": true,
  "userRole": {
  },
  "id": "8fcb5dbc-d5aa-4681-8e31-b001d5168d79",
  "isShared": true,
  "sectionsUrl": "sectionsUrl-value",
  "sectionGroupsUrl": "sectionGroupsUrl-value",
  "links": {
    "oneNoteClientUrl": {
      "href": "href-value"
    },
    "oneNoteWebUrl": {
      "href": "href-value"
    }
  }
}

SDK sample code

GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var notebook = new Notebook
{
	DisplayName = "Notebook name"
};

await graphClient.Me.Onenote.Notebooks
	.Request()
	.AddAsync(notebook);

const options = {
	authProvider,
};

const client = Client.init(options);

const notebook = {
  displayName: "Notebook name"
};

let res = await client.api('/me/onenote/notebooks')
	.version('beta')
	.post({notebook : notebook});

Read the SDK documentation for details on how to add the SDK to your project and create an authProvider instance.