SHshiprush
Notes

Publish a note to knowledge bases

Publishes the note to every knowledge base that contains it. Publishing occurs asynchronously, so the published status will not update immediately.

post/pages/{id}/publish

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

Response

Successful operation

Example response

{
  "page": {
    "id": "6776881149490967959",
    "name": null,
    "title": "PRJ1-N-15 Untitled",
    "document_title": "Untitled | Aha!",
    "created_at": "2019-01-01T00:00:00.000Z",
    "parent_id": null,
    "updated_at": "2019-01-01T00:00:00.000Z",
    "reference_num": "PRJ1-N-15",
    "url": "https://company.aha.io/pages/PRJ1-N-15",
    "resource": "https://company.aha.io/api/v1/pages/PRJ1-N-15",
    "emoji_value": null,
    "document_type": 80,
    "document_type_name": "internal_link",
    "editor_width": null,
    "type_name": "internal link",
    "position": null,
    "location": null,
    "edit_locked": false,
    "linked_record_id": 1007868956,
    "linked_record_type": "Feature",
    "product_id": "131414752",
    "description": {
      "id": "6776881149494485991",
      "body": "",
      "notable_id": "6776881149490967959",
      "notable_type": "Page",
      "editor_version": 2,
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "attachments": []
    },
    "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.