Versions

Create a version comment

Opens a comment thread on a version. Leave out target to comment on the whole page; mentions notifies the people you name.

post/v1/spaces/{spaceId}/versions/{versionId}/comments

Request

  • Base URL: https://api.spacefast.com
  • URL: https://api.spacefast.com/v1/spaces/{spaceId}/versions/{versionId}/comments
  • Auth: HTTP bearer

Path parameters

spaceIdstring required
versionIdstring required

Request body

pagePathstring

Page the thread is anchored to. Ignored when target is a file anchor: that anchor's file.path is the page path, so the thread is always filed under the file it is about.

bodystring required
targetobject nullable

Where in the page or file this thread points. Omit it for a comment on the whole page: the API stores a page anchor. A file anchor files the thread under its file.path; any other shape is stored and returned as sent.

mentionsstring[]

Spacefast user ids to @mention. Each must be on the Space's team and able to open it; GET /v1/spaces/{spaceId}/comments/mentionable lists who qualifies. Mentioned people are notified.

idempotencyKeystring

Response

Response for status 201

$schemastring uri

Canonical JSON Schema URL for this response body. The server also sends it in the Link: rel="describedby" response header.

Changes

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