Comments

Create comments in bulk

Changed on

Create the same comment payload on multiple objects. Bulk commenting is restricted to supported Redrock object types; unsupported types return 400.

post/api/v1/comment/bulk

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Request body

objectIDsstring[] required

Array of target object IDs.

objectCode'PROJ' | 'TASK' | 'OPTASK' | 'DOCU' | 'PRGM' | 'PORT' | 'TMPL' | 'TTSK' | 'ITRN' | 'USER' | 'TSHET' | 'GOAL' | 'TEAMOB' | 'BOARD' | 'CARD' | 'RECORD' | 'GS_APPROVALS' | 'cjaProject' | 'cjaProjectStage' | 'AEM' | 'ESS_SITE_APPROVALS' | 'plays' | 'sapphire_email' | 'Sp_CommentObject' | 'intake-request' required

Object type code identifying the parent object. Supported values by platform:

Adobe Customer Journey Analytics: cjaProject, cjaProjectStage

Adobe Experience Manager: AEM

Adobe Experience Success Studio (ESS): ESS_SITE_APPROVALS

Adobe GenStudio: GS_APPROVALS

Adobe Journey Optimizer B2B Edition: sapphire_email

Adobe Plays: plays

Adobe Workfront: PROJ, TASK, OPTASK, DOCU, PRGM, PORT, TMPL, TTSK, ITRN, USER, TSHET, GOAL, TEAMOB

Adobe Workfront Boards: BOARD, CARD

Adobe Workfront Intake: intake-request

Adobe Workfront Planning: RECORD

Microsoft SharePoint: Sp_CommentObject

contentstring required

Plain-text comment content (maximum 15,000 characters).

contentHTMLstring nullable required

HTML representation of the comment.

isPrivateboolean

If true, visible only within the user's company.

parentIDstring nullable
externalRefIDstring nullable
documentIDstring nullable

Response

OK

_idstring

Comment identifier (24-character hex ObjectId).

documentIDstring

Stable document key for threading and position.

objectIDstring

Associated object ID.

objectCodestring

Associated object type code.

parentIDstring nullable

Parent comment ID for replies.

parentCommentIDstring nullable

Resolved parent comment reference.

typestring

Comment type discriminator.

contentstring

Plain-text content.

contentHTMLstring nullable

HTML content.

isPrivateboolean

Company-scoped visibility flag.

authorIDstring

Author user ID.

authorNamestring

Author display name when available.

customerIdstring

Customer (tenant) identifier.

companyIDstring

Company identifier when applicable.

externalRefIDstring nullable

External correlation ID.

createdAtnumber

Creation timestamp (Unix milliseconds).

lastModifiedAtnumber

Last modification timestamp (Unix milliseconds).

modifiedBystring

User ID of the last modifier.

modifiedboolean

Whether the comment was edited after creation.

editedboolean

Whether the comment content was edited.

deletedboolean

Soft-delete flag.

deletedBystring

User ID that deleted the comment.

deletedDatenumber

Deletion timestamp (Unix milliseconds).

resolvedboolean

Whether the comment thread is resolved.

resolvedBystring

User ID that resolved the comment.

reactionsobject[]

Embedded reaction summaries when present.

Changes

  • 97d93391c7f0Revision changes
    • info

      added the new optional request property /

    • info

      added the optional property // to the response with the status

  • 30ac4b25082aRevision changes
    • breaking

      request property was restricted to a list of enum values

    • info

      added the new AEM enum value to the request property

    • info

      added the new BOARD enum value to the request property

    • info

      added the new CARD enum value to the request property

    • info

      added the new DOCU enum value to the request property

    • info

      added the new ESS_SITE_APPROVALS enum value to the request property

    • info

      added the new GOAL enum value to the request property

    • info

      added the new GS_APPROVALS enum value to the request property

    • info

      added the new ITRN enum value to the request property

    • info

      added the new OPTASK enum value to the request property

    • info

      added the new PORT enum value to the request property

    • info

      added the new PRGM enum value to the request property

    • info

      added the new PROJ enum value to the request property

    • info

      added the new RECORD enum value to the request property

    • info

      added the new Sp_CommentObject enum value to the request property

    • info

      added the new TASK enum value to the request property

    • info

      added the new TEAMOB enum value to the request property

    • info

      added the new TMPL enum value to the request property

    • info

      added the new TSHET enum value to the request property

    • info

      added the new TTSK enum value to the request property

    • info

      added the new USER enum value to the request property

    • info

      added the new cjaProject enum value to the request property

    • info

      added the new cjaProjectStage enum value to the request property

    • info

      added the new intake-request enum value to the request property

    • info

      added the new plays enum value to the request property

    • info

      added the new sapphire_email enum value to the request property