Notes

Create a note

"Notes" in the web interface are referenced as "pages" from API endpoints.

post/products/{product_id}/pages

Path parameters

product_idstring required

ProductId identifier

Request body

Example request

{
  "page": {
    "name": "New name for the note",
    "description_attributes": {
      "body": "<p>An awesome new note</p>",
      "table_of_contents_enabled": true
    }
  }
}

Response

Successful operation

Changes

Changed in 2 of the 5 revisions of this API.221

  • bfbe6f6d74a122See the full diff
    • the response property page/workflow_status/workflow_status_category became nullable for the status 200

      response-property-became-nullable

    • the page/workflow_status/workflow_status_category response's property type/format changed from object/ to null/ for status 200

      response-property-type-changed

    • removed the optional property page/workflow_status/workflow_status_category/id from the response with the 200 status

      response-optional-property-removed

    • removed the optional property page/workflow_status/workflow_status_category/name from the response with the 200 status

      response-optional-property-removed

    • added the optional property page/workflow_status/workflow_status_category to the response with the 200 status

      response-optional-property-added