comments

create

Create a footer comment on a page

Flag	Type	Required	Description
--body	string	No	Comment body in storage format XML (required)
--page-id	string	No	Page ID to create comment on (required)

Example:

cf comments create

create-property

Create content property for comment

Creates a new content property for a comment.

Permissions required: Permission to update the comment.

POST /comments/{comment-id}/properties

Flag	Type	Required	Description
--body	string	No	request body (JSON string, @file, or - for stdin)
--comment-id	string	Yes	The ID of the comment to create a property for.

Example:

cf comments create-property --comment-id <comment-id>

delete

Delete a footer comment

Flag	Type	Required	Description
--comment-id	string	No	Comment ID to delete (required)

Example:

cf comments delete

delete-property-by-id

Delete content property for comment by id

Deletes a content property for a comment by its id.

Permissions required: Permission to edit the comment.

DELETE /comments/{comment-id}/properties/{property-id}

Flag	Type	Required	Description
--comment-id	string	Yes	The ID of the comment the property belongs to.
--property-id	string	Yes	The ID of the property to be deleted.

Example:

cf comments delete-property-by-id --comment-id <comment-id> --property-id <property-id>

get-content-properties

Get content properties for comment

Retrieves Content Properties attached to a specified comment.

Permissions required: Permission to view the comment.

GET /comments/{comment-id}/properties

Flag	Type	Required	Description
--comment-id	string	Yes	The ID of the comment for which content properties should be returned.
--cursor	string	No	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
--key	string	No	Filters the response to return a specific content property with matching key (case sensitive).
--limit	string	No	Maximum number of attachments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
--sort	string	No	Used to sort the result by a particular field.

Example:

cf comments get-content-properties --comment-id <comment-id>

get-content-properties-by-id

Get content property for comment by id

Retrieves a specific Content Property by ID that is attached to a specified comment.

Permissions required: Permission to view the comment.

GET /comments/{comment-id}/properties/{property-id}

Flag	Type	Required	Description
--comment-id	string	Yes	The ID of the comment for which content properties should be returned.
--property-id	string	Yes	The ID of the content property being requested.

Example:

cf comments get-content-properties-by-id --comment-id <comment-id> --property-id <property-id>

list

List footer comments on a page

Flag	Type	Required	Description
--page-id	string	No	Page ID to list comments for (required)

Example:

cf comments list

update-property-by-id

Update content property for comment by id

Update a content property for a comment by its id.

Permissions required: Permission to edit the comment.

PUT /comments/{comment-id}/properties/{property-id}

Flag	Type	Required	Description
--body	string	No	request body (JSON string, @file, or - for stdin)
--comment-id	string	Yes	The ID of the comment the property belongs to.
--property-id	string	Yes	The ID of the property to be updated.

Example:

cf comments update-property-by-id --comment-id <comment-id> --property-id <property-id>