Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

RingCentral Notes API

The Notes API from RingCentral — 5 operation(s) for notes.

RingCentral Notes API is one of 88 APIs that RingCentral publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Notes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 8 operations across 5 paths, and defines 8 schemas. It is described by OpenAPI 3.0.3, at version 1.0.58-20240529-47eda8bd.

Requests are made against 4 base URLs: https://platform.ringcentral.com, https://media.ringcentral.com, https://platform.devtest.ringcentral.com, https://platform.devtest.ringcentral.com.

8 operations 5 paths 8 schemas 1 DELETE2 GET1 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.58-20240529-47eda8bd
Servers
https://platform.ringcentral.com
https://media.ringcentral.com
https://platform.devtest.ringcentral.com
https://platform.devtest.ringcentral.com
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

RingCentral Notes API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow. By default, every request must be authenticated.

Paths & Operations 8

Across 5 paths, the API surfaces 8 operations — 1 DELETE, 2 GET, 1 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Notes 8
GET
/team-messaging/v1/chats/{chatId}/notes
List Notes
listChatNotesNew 7 params → 200400403404
POST
/team-messaging/v1/chats/{chatId}/notes
Create Note
createChatNoteNew 1 param body → 200400403404
GET
/team-messaging/v1/notes/{noteId}
Get Note
readUserNoteNew 1 param → 200404
DELETE
/team-messaging/v1/notes/{noteId}
Delete Note
deleteNoteNew 1 param → 204400403404
PATCH
/team-messaging/v1/notes/{noteId}
Update Note
patchNoteNew 2 params body → 200400403404
POST
/team-messaging/v1/notes/{noteId}/lock
Lock Note
lockNoteNew 1 param → 204400403404
POST
/team-messaging/v1/notes/{noteId}/publish
Publish Note
publishNoteNew 1 param → 200400404
POST
/team-messaging/v1/notes/{noteId}/unlock
Unlock Note
unlockNoteNew 1 param → 204400403404

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are TMNoteInfo (11 properties), TMNavigationInfo (2 properties), TMCreateNoteRequest (2 properties), TMNoteList (2 properties). Each schema is shown below with its type and property counts.

TMCreateNoteRequest
object
2 properties 1 required
TMNoteList
object
2 properties
TMCreatorInfo
object
Note creator information
1 property
TMNavigationInfo
object
2 properties
TMNoteWithBodyInfo
LockedByInfo
object
Returned for the note being edited (locked) at the current moment. Information on the user editing the note
1 property
TMNoteInfo
object
11 properties
LastModifiedByInfo
object
Note last modification information
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ringcentral-notes-api-openapi.yml Raw ↑

Other APIs RingCentral publishes across the network.

RingCentral SMS API
RingCentral Team Messaging API
RingCentral Video API
RingCentral Fax API
RingCentral Data API
RingCentral Audio and Video AI API
RingCentral Call Log API
RingCentral Call Analytics API
RingCentral Presence API
RingCentral Voicemail API
RingCentral Provisioning API
RingCentral Webhooks and Subscriptions API