Skip to main content
POST
Share a note

Authorizations

Authorization
string
header
required

An API key from the web app (Settings → Developer), sent as Authorization: Bearer rvl_live_….

Path Parameters

noteId
string
required

Note id, note_….

Body

application/json
users
string[]
required

Who to share with: each an email address or a user id (user_…) from GET /v1/org/members. They must be active members of the owner's organization.

Required array length: 1 - 20 elements
Minimum string length: 1
permission
enum<string>
default:read

read (default) or write. Sharing again with someone who has it changes their permission.

Available options:
read,
write

Response

OK

shared
object[]
required

Every requested user, with their permission now.

created
number
required

Shares this request added.

updated
number
required

Requested users who already had it, with the permission set now.

notice
string
required