Adobe CX Commenting API

The Adobe Customer Experience (CX) Commenting API v1 provides an HTTP JSON interface for creating, reading, updating, and deleting comments, replies, and reactions associated with supported objects across different platforms of CX.

Overview

Adobe CX Commenting is a unified commenting service associated with supported objects across different platforms of CX including Adobe Workfront, AEP, GenStudio, and more. The REST v1 API exposes comment lifecycle operations with cursor-based pagination, object-level access control, and Adobe IMS OAuth 2.0 authentication.

All v1 endpoints are prefixed with /api/v1/. Breaking changes require a new major version; non-breaking additions (optional fields, new endpoints) can ship under v1.

Supported object codes

The objectCode parameter identifies the type of object a comment is attached to. The following codes are supported:

Platform

Object codes

Adobe Customer Journey Analytics

cjaProject

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

Discover

Getting Started

Set up authentication, learn required headers, and make your first API call.

Try the API

Interactive API reference with endpoint descriptions, request schemas, and curl examples.

Error handling

HTTP status codes and response shapes for client and server errors.

Limits

Pagination caps, content size limits, edit window, and bulk comment constraints.