Comments

Create file comment

Creates a new comment on the specified file.

post/api/files/{id}/comments

Request

  • Base URL: https://docs.weavy.com (the document declares no server; this is the origin it was published from)
  • URL: https://docs.weavy.com/api/files/{id}/comments
  • Auth: none declared

Path parameters

idinteger required

File id

Request body

textstring nullable

The message text.

metadataobject nullable

Additional metadata properties, e.g. { "color": "blue", "size": "XL" }.

tagsstring[] nullable

A list of tags to associate with the item.

Response

Created

textstring nullable

Gets the message text.

htmlstring nullable

Gets the message text as html.

plainstring nullable

Gets the message text with all formatting stripped.

metadataobject nullable

Gets or sets additional metadata.

tagsstring[] nullable
is_starredboolean nullable

If the authenticated user has starred the entity.

is_subscribedboolean nullable

If the authenticated user has subscribed to the entity.

is_trashedboolean nullable
created_atstring date-time nullable

Gets or sets the date and time (UTC) the entity was created.

updated_atstring date-time nullable

Changes

No recorded changes to this operation across all 1 revision of this API.