Notes API

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

Create a note

POST /api/v1/products/:product_id/pages

Parameters
Name	Description
`product_id *`	Numeric ID or key of the product
`document_type`	Type of document to be created - can be: note, whiteboard, folder, internal_link, or external_link. Defaults to note
`name *`	Name of the page.
`description_attributes`	Description of the page — see example.
`parent_id`	ID of a parent page or folder to nest this page under
`tags`	Tags to add to the page. Multiple tags must be separated by commas.
`editor_width`	Controls the width of the page when viewed. Options are: NARROW, FULL

Example request

POST /api/v1/products/PRJ1/pages

Example CURL command

curl "https://company.aha.io/api/v1/products/PRJ1/pages" -d '{"page":{"name":"Note 3","description_attributes":{"body":"\u003cp\u003eAn awesome new note\u003c/p\u003e"}}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
contentType: application/json
accept: application/json

Request body

Response

Status: 200 OK
contentType: application/json; charset=utf-8

Response body