SHshiprush
Notes

Update a note

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

put/pages/{id}

Request

  • Base URL
    https://company.aha.io/api/v1
  • Auth
    • OAuth 2
      Authorization codehttps://{account-domain}.aha.io/oauth/authorize
      Token URLhttps://{account-domain}.aha.io/oauth/token
    • or HTTP bearer
    • or API key in cookie session
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

Id 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

Example response

{
  "page": {
    "id": "280859787",
    "name": "Build products customers love",
    "title": "PRJ1-N-6 Build products customers love",
    "document_title": "Build products customers love | Aha!",
    "created_at": "2019-01-01T00:00:00.000Z",
    "parent_id": null,
    "updated_at": "2019-01-01T00:00:00.000Z",
    "reference_num": "PRJ1-N-6",
    "url": "https://company.aha.io/pages/PRJ1-N-6",
    "resource": "https://company.aha.io/api/v1/pages/PRJ1-N-6",
    "emoji_value": null,
    "document_type": 70,
    "document_type_name": "external_link",
    "editor_width": null,
    "type_name": "external link",
    "position": 500000,
    "location": null,
    "edit_locked": false,
    "external_url": "https://www.aha.io/solutions/product",
    "product_id": "131414752",
    "description": null,
    "tags": [],
    "full_tags": [],
    "comments_count": 0,
    "custom_fields": [],
    "workflow_status": {
      "id": "369936966",
      "name": "Not Started",
      "position": 1,
      "complete": false,
      "color": "#dce7c6",
      "workflow_status_category": null
    }
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.