collaboration

Create comment threads

Start a comment thread on one anchor of a commentable page (a Discovery overview or sentiment card, or an Experience replay) as the signed-in member, optionally mentioning organization members, who are emailed. Returns the thread and the new comment's id; a retry with the same Idempotency-Key returns the thread its first attempt started. Needs a signed-in user: API keys are refused.

post/api/v1/collaboration/comment-threads/create

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/collaboration/comment-threads/create
  • Auth: OAuth 2 (authorization code, authorization URL https://auth.point11.ai/oauth2/authorize, token URL https://auth.point11.ai/oauth2/token)

Headers

Point11-Organizationstring uuid

Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.

Idempotency-Keystring uuid required

UUID naming this intent. Retry with the same key; reuse for other input is 409.

Request body

surfaceIdstring required

The commentable page, e.g. campaigns.discovery.overview

artifactIdstring uuid required

The campaign or run the page shows

viewStateobject required

The page state to return to, as the surface defines it

bodystring required

The comment text; at most 4000 characters once trimmed

mentionedUserIdsstring[]

Ids of organization members to mention (from collaboration.mentionable-members.list)

Response

Success.

commentIdstring required

The id of the comment this call posted

Changes

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