Create notebook
Important
APIs under the /beta
version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported.
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.
Permission type | Permissions (from least to most privileged) |
---|---|
Delegated (work or school account) | Notes.Create, Notes.ReadWrite, Notes.ReadWrite.All |
Delegated (personal Microsoft account) | Notes.Create, Notes.ReadWrite |
Application | Notes.ReadWrite.All |
HTTP request
POST /me/onenote/notebooks
POST /users/{id | userPrincipalName}/onenote/notebooks
POST /groups/{id}/onenote/notebooks
POST /sites/{id}/onenote/notebooks
Request headers
Name | Type | Description |
---|---|---|
Authorization | string | Bearer {token}. Required. |
Content-Type | string | application/json |
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"
}
}
}
Feedback
Loading feedback...