circle-controller

POST /api/circles/{circle}/notebooks

Changed on

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/circles/{circle}/notebooks
  • Auth
    none declared

Path parameters

circleinteger required

Request body

newTitlestring
referenceHandling'UPDATE_VISIBLE_TEXT' | 'KEEP_VISIBLE_TEXT'
descriptionstring
notebookGroupIdinteger

Response

OK

hasAttachedBookboolean
readonlyboolean
readmeContentstring

Container-owned notebook readme markdown. Omitted when absent.

Changes

    • warning

      changed the pattern of the request property from ^[\s\x00-\x1F]*[^\\/:*?"<>|\x00-\x1F]*[\s\x00-\x1F]*$ to ^[\s\x00-\x1F]*[^\\/:*?"<>\x00-\x1F]*[\s\x00-\x1F]*$

    • warning

      changed the pattern of the request property from ^[^\\/:]*$ to ^[\s\x00-\x1F]*[^\\/:*?"<>|\x00-\x1F]*[\s\x00-\x1F]*$