---
title: "Create comment invitations"
method: POST
path: "/api/v1/collaboration/comment-invitations/create"
tags: ["collaboration"]
---

# Create comment invitations

`POST /api/v1/collaboration/comment-invitations/create`

## Request

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

Invite up to five people named in a comment you wrote into the organization as viewers, with the comment as the invitation message; an address that already belongs to a member mentions them instead, and only a newly mentioned member is emailed. Each address settles on its own (`invited`, `mentioned`, or `failed` with the reason). The user must approve each invitation: it grants organization access. Needs a signed-in user who may invite members.

## Headers

- `Point11-Organization` string, uuid
- `Idempotency-Key` string, uuid, required
- `Point11-Confirm` 'true', required

## Request body

- CollaborationCommentInvitationsCreateRequest
  - `threadId` string, uuid, required: The thread of the comment
  - `commentId` string, uuid, required: A comment the caller wrote
  - `invitations` object[], required
    - `email` string, email, required
    - `operationId` string, uuid, required: One per address; reuse it on retry to replay the same invitation

## Response `200`

Success.

- CollaborationCommentInvitationsCreateResponse
  - `thread` CollaborationThreadsItem, required
    - `id` string, required
    - `artifactType` string, required
    - `artifactId` string, required
    - `surfaceId` string, required
    - `canonicalHref` string, required: The dashboard path the thread was left on
    - `anchor` union, required
      - object
        - `kind` 'metric_card', required
        - `key` string, required
        - `label` string, required
      - object
        - `kind` 'table_card', required
        - `key` string, required
        - `label` string, required
      - object
        - `kind` 'report_section', required
        - `key` string, required
        - `label` string, required
      - object
        - `kind` 'replay', required
        - `key` 'replay', required
        - `label` string, required
    - `anchorKey` string, required
    - `viewState` object, required
    - `snapshot` object, required: What the anchor showed when the thread was started
      - `version` string, required
      - `title` string, required
      - `subtitle` string, nullable
      - `generatedAt` string, required
      - `values` object[], required
        - `label` string, required
        - `value` string, required
        - `detail` string, nullable
    - `status` 'open' | 'resolved', required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `resolvedAt` string, date-time, nullable, required
    - `creator` object, required
      - `id` string, required
      - `name` string, nullable, required
      - `email` string, required
      - `imageUrl` string, nullable, required
    - `resolvedBy` object, nullable, required
      - `id` string, required
      - `name` string, nullable, required
      - `email` string, required
      - `imageUrl` string, nullable, required
    - `comments` object[], required: The opening comment and the most recent replies, oldest first
      - `id` string, required
      - `parentCommentId` string, nullable, required
      - `body` string, required
      - `createdAt` string, date-time, required
      - `editedAt` string, date-time, nullable, required
      - `author` object, required
        - `id` string, required
        - `name` string, nullable, required
        - `email` string, required
        - `imageUrl` string, nullable, required
      - `mentions` object[], required
        - `id` string, required
        - `name` string, nullable, required
        - `email` string, required
        - `imageUrl` string, nullable, required
      - `invitations` object[], required
        - `invitationId` string, required
        - `email` string, required
        - `status` 'pending' | 'accepted' | 'revoked' | 'expired', required
        - `joined` object, nullable, required: The member the invitation became, once accepted
          - `id` string, required
          - `name` string, nullable, required
          - `email` string, required
          - `imageUrl` string, nullable, required
    - `mentionUserIds` string[], required
    - `unread` boolean, required: Whether the thread changed since the caller last read it
    - `mentionedMe` boolean, required: Whether any comment in the thread mentions the caller
  - `invitations` union[], required
    - union
      - object
        - `email` string, required
        - `status` 'invited', required
        - `invitationId` string, required
      - object
        - `email` string, required
        - `status` 'mentioned', required: The address is a member's, so they were mentioned
        - `user` object, required
          - `id` string, required
          - `name` string, nullable, required
          - `email` string, required
          - `imageUrl` string, nullable, required
      - object
        - `email` string, required
        - `status` 'failed', required
        - `error` string, required: Why Identity did not issue this invitation

## Other responses

- `400`: The input, query, or Idempotency-Key is invalid.
- `401`: The bearer is missing, expired, or not accepted.
- `402`: Billing refused the write: the code names the reason and `details.reason` carries it.
- `403`: The credential lacks the operation's scope or role, or the operation needs a different door.
- `404`: The resource or organization does not exist for this caller.
- `405`: This path takes another HTTP method, named in `Allow`.
- `409`: The request conflicts with current state or with prior use of its Idempotency-Key.
- `413`: The request, or the answer it asks for, is too large; narrow it.
- `429`: The credential's rate budget is spent; retry after `Retry-After` seconds.
- `500`: An unexpected server failure; retry later. Only `request_id` identifies it.
- `503`: A dependency is temporarily unavailable; retry after `Retry-After` seconds.
- `default`: Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.

---

[API](https://skmtc.dev/point11/apis/point11-api.md) · [All operations](https://skmtc.dev/point11/apis/point11-api/llms.txt) · [OpenAPI document](https://skmtc.dev/point11/apis/point11-api/revisions/36a84c7aca11?raw)