Create Comment

Creates a new comment. The content should be in a valid HTML format.

Example content:
"<p>"Hello World!</p>"
Result:
Hello World!

Mentions can be added directly to the content field. However, a HTML attribute is required to achieved this. The required mention HTML attribute looks like:
"<span class="mentioned-user" contenteditable="false">{email_to_mention}</span>"

Example content with mentions:
"<p>"This needs some changes <span class="mentioned-user" contenteditable="false">@[email protected]</span>!</p>"
Result:
This needs some changes @[email protected]!

Note that it will throw an error if the email is not a member or doesn't have a role on that instance the comment is being added.

Note: Currently comments can only be added to a content field resource. This will expand to more resource types in future releases.

Body: raw JSON

namedescription
resourceZUID[string] Required. The item ZUID of the content field where we want the comment to be created.
content[string] Required. The message to display. Should be in a valid HTML format.
instanceZUID[string] Required. The ZUID of the instance where the resource is located.
scopeTo[string] Required. The ZUID of the content field where we want the comment to be created.
Body Params

Comment object to create

string
required
string
required
string
required
string
required
Responses

Language
Credentials
Header
Response
Choose an example:
application/json