Collections

Update a note on a custom collection (called Dashboards in the UI)

Changed on

Only the note's author may edit it. Omitted fields are left alone rather than cleared.

patch/api_partner/collections/{collection_slug}/notes/{note_id}

Request

  • Base URL
    https://api.scite.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.scite.ai/api_partner/collections/{collection_slug}/notes/{note_id}
  • Auth
    HTTP bearer

Path parameters

collection_slugstring required
note_idinteger required

Headers

authorizationstring

Set to Bearer <token> to pass token for authorization.

Request body

titlestring nullable
bodystring nullable
bodyFormat'PLAIN' | 'MARKDOWN' nullable
emailstring email required

Response

Successful Response

idinteger required
dashboardIdinteger required
targetType'COLLECTION'
titlestring required
bodystring
bodyFormat'PLAIN' | 'MARKDOWN'
createdByEmailstring nullable
createdByNamestring nullable
updatedByEmailstring nullable
updatedByNamestring nullable
isEditedByOtherboolean
createdAtstring date-time required
lastUpdatedstring date-time required

Changes