close anchor

Comments

To get information on comments:

GET /comments

Parameters

Param Type Description Optional
id string The UUID of an individual comment.
user string The UUID of the project user identified with a comment, being the user who posted it, if known. Include an empty value to query for comments identified with no project user.
content string The UUID of a content entry by which to filter the comment(s) provided.
approved boolean Indicate whether or not to filter entries by this property. Include a value of either true or false to indicate the entries to be provided.
text string Include text by which to filter entries. Input will be parsed for up to ten keywords and treated as a filter, in that only entries with keyword(s) present in the fields below will be included.
fields string Indicate, by providing a comma-delimited list, the field(s) in which to expect text keyword(s) be present. If a field includes localized text, only values in the endpoint transaction locale will be queried. If empty or not provided, each of these valid fields will be included: email, name, text.
order string Indicate, by providing a comma-delimited list, the field(s) by which to order entries found. Include a '-' prefix if descending order is preferred in a given field ('+' is inferred by default). If empty or not provided, these valid fields will not be explicitly included: date_time.edit, date_time.init, email, id.
page integer Identify the page on which to begin delivering entries. If not provided, the default value of 1 will be inferred.
limit integer Indicate a total of up to 100 entries to be delivered. If not provided, the default value of 10 will be inferred.
data string Indicate, by providing a comma-delimited list, the data field(s) to be delivered by this endpoint. If empty or not provided, this endpoint will include by default each of the data field(s) identified with the comment object.

The data object provided by this endpoint includes both a total (integer) of entries found, and an index (array) of comment object(s).

To post a comment:

POST /comments

Parameters

Provide the input field(s) below as a JSON-encoded data object:

Param Type Description Optional
content string The UUID of the content entry to which this comment is being posted.
name string The personal name or identity provided for, or by, the user posting this comment.
email string The e-mail identified with the user posting this comment, if provided.
text string The textual body of the comment.

The data object provided by this endpoint is the comment inserted to the project and identified with the content entry indicated.

Errors

If there is an endpoint transaction failure, or a problem with user input data, an error is provided:

ID/Type Description
invalid_email The email to be identified with the comment is not valid.
invalid_text The text body of the comment is an empty value or was not provided.

If an error is not described on this page, the platform-wide error table provides further information.

To edit or update a comment:

PUT /comments

In order to edit or update a comment, log in a user identified with editor-level privileges.

Parameters

Provide the input field(s) below as a JSON-encoded data object:

Param Type Description
id string The UUID of the posted comment.
approved boolean Indicate whether or not this entry's been evaluated by an editor-level user. This provides for an expression to filter or exclude based on editorial purview, if desired.

The data object provided by this endpoint is the updated comment.

Errors

If there is an endpoint transaction failure, or a problem with user input data, an error is provided:

ID/Type Description
invalid_boolean The approved boolean was not declared.

If an error is not described on this page, the platform-wide error table provides further information.

To delete a comment:

DELETE /comments

In order to delete a comment, log in a user identified with editor-level privileges.

Param Type Description
id string The UUID of the posted comment.

The data object provided by this endpoint is the deleted comment.

Register for an Invitation
Thank you!
We'll be in touch.
First Name*
Last Name*
(optional) Business Name
Role*
Email*