Note API

The Note API helps you manage note posts of a team/group.

To use the Note API, you need an access token that you can get by authenticating with a user account, not a service account.

The API scopes are as follows:

• group.note or group.note.read: Only the API operations associated with the team/group note are available.

Manage the team/group note feature {#manage-groupnote}

The team/group note is part of the team/group features. To enable or disable the team/group note, you need to use the useNote property of the API that manages teams or groups.

Managing teams requires the orgunit or directory scope, and managing groups requires the group or directory scope.

To use the team/group note after enabling it using useNote, you need to create a note using the following API operation.

Even if you disable the team/group note using useNote, the note data will remain unchanged. To actually delete the note data, you need to use the following API operation.

Manage team/group note posts {#manage-groupnote-post}

You can manage note posts using the following API operations with a team/group ID (groupId) specified.

Add a post by specifying its title and body. You can include HTML tags in the body. You can also specify whether to allow co-editing (enableCollaboration ), whether it is a notice (isNotice), and whether to send a notification when a post is created (sendNotifications).

{   "title": "Post title",   "body": "<h1>Post</h1> Body",   "enableCollaboration": false,   "isNotice": false,   "sendNotifications": false}

Manage team/group note post attachments {#manage-groupnote-post-attachment}

You can attach multiple files to a note post.

For how to get attachments, see Upload or Download Files.