Sanity Library Reference Docs
    Preparing search index...

    Type Alias CollaborationCommentCreateAlpha

    CollaborationCommentCreate: {
        _id?: string;
        context?: Record<string, unknown>;
        message: CollaborationCommentMessage;
    } & (
        | {
            parentCommentId?: never;
            target: CollaborationCommentTarget;
            threadId?: string;
        }
        | { parentCommentId: string; target?: never; threadId?: never }
    )

    Comment to create with collaboration.comments.create.

    A top-level comment requires target; a reply requires parentCommentId (never both). Replies inherit target, status, and threadId from the parent comment.

    // `message` is an array of Portable Text blocks
    await client.collaboration.comments.create({
      message,
      target: {documentId: 'doc-1', documentType: 'article'},
    })

    await client.collaboration.comments.create({
      message,
      target: {
        documentId: 'doc-1',
        documentType: 'article',
        path: 'body',
        range: {start: {_key: 'block-1', offset: 0}, end: {_key: 'block-1', offset: 5}},
      },
    })

    await client.collaboration.comments.create({
      message,
      parentCommentId: 'comment-1',
    })

    Type declaration

    • Optional_id?: string

      Provide to control the ID of the created comment document

    • Optionalcontext?: Record<string, unknown>
    • message: CollaborationCommentMessage
    • {
          parentCommentId?: never;
          target: CollaborationCommentTarget;
          threadId?: string;
      }
    • { parentCommentId: string; target?: never; threadId?: never }

    Settings

    Member Visibility

    On This Page

    Examples