/comments

Creates a Comment object with the given values.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Headers

X-Account-TokenstringRequired

Token identifying the end user.

Query parameters

is_debug_modebooleanOptional

Whether to include debug fields (such as log file links) in the response.

run_asyncbooleanOptional

Whether or not third-party updates should be run asynchronously.

Request

This endpoint expects an object.

modelobjectRequired

Description

The Comment object is used to represent a comment on a ticket.

Usage Example

TODO

Response

modelobject

Description

The Comment object is used to represent a comment on a ticket.

Usage Example

TODO

warningslist of objects

errorslist of objects

logslist of objects or null

Supported POST model parameters

bodystring or nullRequired

The comment's text body.

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

remote_idstring or nullOptional

The third-party API ID of the matching object.

userstring or nullOptionalformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

remote_idstring or nullOptional

The third-party API ID of the matching object.

userstring or nullOptionalformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

bodystring or nullOptional

The comment's text body.

html_bodystring or nullOptional

The comment's text body formatted as html.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

userstring or nullOptionalformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

bodystring or nullOptional

The comment's text body.

ticketstring or nullOptionalformat: "uuid"

The ticket associated with the comment.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

html_bodystring or nullRequired

The comment's text body formatted as html.

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

is_privateboolean or nullRequired

Whether or not the comment is internal.

remote_idstring or nullOptional

The third-party API ID of the matching object.

userstring or nullOptionalformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

contactstring or nullOptionalformat: "uuid"

The author of the Comment, if the author is a Contact.If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

bodystring or nullOptional

The comment's text body.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

userstring or nullRequiredformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

is_privateboolean or nullRequired

Whether or not the comment is internal.

remote_idstring or nullOptional

The third-party API ID of the matching object.

bodystring or nullOptional

The comment's text body.

html_bodystring or nullOptional

The comment's text body formatted as html.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

html_bodystring or nullRequired

The comment's text body formatted as html.

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

remote_idstring or nullOptional

The third-party API ID of the matching object.

userstring or nullOptionalformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

bodystring or nullOptional

The comment's text body.

is_privateboolean or nullOptional

Whether or not the comment is internal.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

bodystring or nullRequired

The comment's text body.

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

remote_idstring or nullOptional

The third-party API ID of the matching object.

userstring or nullOptionalformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

userstring or nullRequiredformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

bodystring or nullRequired

The comment's text body.

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

is_privateboolean or nullRequired

Whether or not the comment is internal.

remote_idstring or nullOptional

The third-party API ID of the matching object.

html_bodystring or nullOptional

The comment's text body formatted as html.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

userstring or nullRequiredformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

remote_idstring or nullOptional

The third-party API ID of the matching object.

bodystring or nullOptional

The comment's text body.

html_bodystring or nullOptional

The comment's text body formatted as html.

is_privateboolean or nullOptional

Whether or not the comment is internal.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

contactstring or nullRequiredformat: "uuid"

The author of the Comment, if the author is a Contact.If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

html_bodystring or nullRequired

The comment's text body formatted as html.

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

remote_idstring or nullOptional

The third-party API ID of the matching object.

userstring or nullOptionalformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

is_privateboolean or nullOptional

Whether or not the comment is internal.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

bodystring or nullRequired

The comment's text body.

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

remote_idstring or nullOptional

The third-party API ID of the matching object.

userstring or nullOptionalformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

html_bodystring or nullRequired

The comment's text body formatted as html.

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

is_privateboolean or nullRequired

Whether or not the comment is internal.

remote_idstring or nullOptional

The third-party API ID of the matching object.

userstring or nullOptionalformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

contactstring or nullOptionalformat: "uuid"

The author of the Comment, if the author is a Contact.If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

userstring or nullRequiredformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

bodystring or nullRequired

The comment's text body.

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

remote_idstring or nullOptional

The third-party API ID of the matching object.

is_privateboolean or nullOptional

Whether or not the comment is internal.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

remote_idstring or nullOptional

The third-party API ID of the matching object.

userstring or nullOptionalformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

html_bodystring or nullOptional

The comment's text body formatted as html.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

remote_idstring or nullOptional

The third-party API ID of the matching object.

userstring or nullOptionalformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

bodystring or nullOptional

The comment's text body.

html_bodystring or nullOptional

The comment's text body formatted as html.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

remote_idstring or nullOptional

The third-party API ID of the matching object.

userstring or nullOptionalformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

html_bodystring or nullOptional

The comment's text body formatted as html.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

userstring or nullRequiredformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

bodystring or nullRequired

The comment's text body.

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

is_privateboolean or nullRequired

Whether or not the comment is internal.

remote_idstring or nullOptional

The third-party API ID of the matching object.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

bodystring or nullRequired

The comment's text body.

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

remote_idstring or nullOptional

The third-party API ID of the matching object.

userstring or nullOptionalformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

bodystring or nullRequired

The comment's text body.

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

remote_idstring or nullOptional

The third-party API ID of the matching object.

userstring or nullOptionalformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

bodystring or nullRequired

The comment's text body.

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

remote_idstring or nullOptional

The third-party API ID of the matching object.

userstring or nullOptionalformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

is_privateboolean or nullOptional

Whether or not the comment is internal.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

html_bodystring or nullRequired

The comment's text body formatted as html.

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

remote_idstring or nullOptional

The third-party API ID of the matching object.

userstring or nullOptionalformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

is_privateboolean or nullOptional

Whether or not the comment is internal.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

bodystring or nullRequired

The comment's text body.

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

remote_idstring or nullOptional

The third-party API ID of the matching object.

userstring or nullOptionalformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

is_privateboolean or nullOptional

Whether or not the comment is internal.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

bodystring or nullRequired

The comment's text body.

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

remote_idstring or nullOptional

The third-party API ID of the matching object.

userstring or nullOptionalformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

remote_idstring or nullOptional

The third-party API ID of the matching object.

userstring or nullOptionalformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

contactstring or nullOptionalformat: "uuid"

The author of the Comment, if the author is a Contact.If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

bodystring or nullOptional

The comment's text body.

html_bodystring or nullOptional

The comment's text body formatted as html.

is_privateboolean or nullOptional

Whether or not the comment is internal.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

bodystring or nullRequired

The comment's text body.

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

remote_idstring or nullOptional

The third-party API ID of the matching object.

userstring or nullOptionalformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

is_privateboolean or nullRequired

Whether or not the comment is internal.

remote_idstring or nullOptional

The third-party API ID of the matching object.

userstring or nullOptionalformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

bodystring or nullOptional

The comment's text body.

html_bodystring or nullOptional

The comment's text body formatted as html.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

bodystring or nullRequired

The comment's text body.

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

remote_idstring or nullOptional

The third-party API ID of the matching object.

userstring or nullOptionalformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

remote_idstring or nullOptional

The third-party API ID of the matching object.

userstring or nullOptionalformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

bodystring or nullOptional

The comment's text body.

html_bodystring or nullOptional

The comment's text body formatted as html.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

userstring or nullOptionalformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

bodystring or nullOptional

The comment's text body.

ticketstring or nullOptionalformat: "uuid"

The ticket associated with the comment.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

html_bodystring or nullRequired

The comment's text body formatted as html.

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

is_privateboolean or nullRequired

Whether or not the comment is internal.

remote_idstring or nullOptional

The third-party API ID of the matching object.

userstring or nullOptionalformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

contactstring or nullOptionalformat: "uuid"

The author of the Comment, if the author is a Contact.If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

bodystring or nullOptional

The comment's text body.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

userstring or nullRequiredformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

is_privateboolean or nullRequired

Whether or not the comment is internal.

remote_idstring or nullOptional

The third-party API ID of the matching object.

bodystring or nullOptional

The comment's text body.

html_bodystring or nullOptional

The comment's text body formatted as html.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

html_bodystring or nullRequired

The comment's text body formatted as html.

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

remote_idstring or nullOptional

The third-party API ID of the matching object.

userstring or nullOptionalformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

bodystring or nullOptional

The comment's text body.

is_privateboolean or nullOptional

Whether or not the comment is internal.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

bodystring or nullRequired

The comment's text body.

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

remote_idstring or nullOptional

The third-party API ID of the matching object.

userstring or nullOptionalformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

userstring or nullRequiredformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

bodystring or nullRequired

The comment's text body.

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

is_privateboolean or nullRequired

Whether or not the comment is internal.

remote_idstring or nullOptional

The third-party API ID of the matching object.

html_bodystring or nullOptional

The comment's text body formatted as html.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

userstring or nullRequiredformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

remote_idstring or nullOptional

The third-party API ID of the matching object.

bodystring or nullOptional

The comment's text body.

html_bodystring or nullOptional

The comment's text body formatted as html.

is_privateboolean or nullOptional

Whether or not the comment is internal.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

contactstring or nullRequiredformat: "uuid"

The author of the Comment, if the author is a Contact.If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

html_bodystring or nullRequired

The comment's text body formatted as html.

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

remote_idstring or nullOptional

The third-party API ID of the matching object.

userstring or nullOptionalformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

is_privateboolean or nullOptional

Whether or not the comment is internal.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

bodystring or nullRequired

The comment's text body.

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

remote_idstring or nullOptional

The third-party API ID of the matching object.

userstring or nullOptionalformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

html_bodystring or nullRequired

The comment's text body formatted as html.

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

is_privateboolean or nullRequired

Whether or not the comment is internal.

remote_idstring or nullOptional

The third-party API ID of the matching object.

userstring or nullOptionalformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

contactstring or nullOptionalformat: "uuid"

The author of the Comment, if the author is a Contact.If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

userstring or nullRequiredformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

bodystring or nullRequired

The comment's text body.

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

remote_idstring or nullOptional

The third-party API ID of the matching object.

is_privateboolean or nullOptional

Whether or not the comment is internal.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

remote_idstring or nullOptional

The third-party API ID of the matching object.

userstring or nullOptionalformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

html_bodystring or nullOptional

The comment's text body formatted as html.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

remote_idstring or nullOptional

The third-party API ID of the matching object.

userstring or nullOptionalformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

bodystring or nullOptional

The comment's text body.

html_bodystring or nullOptional

The comment's text body formatted as html.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

remote_idstring or nullOptional

The third-party API ID of the matching object.

userstring or nullOptionalformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

html_bodystring or nullOptional

The comment's text body formatted as html.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

userstring or nullRequiredformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

bodystring or nullRequired

The comment's text body.

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

is_privateboolean or nullRequired

Whether or not the comment is internal.

remote_idstring or nullOptional

The third-party API ID of the matching object.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

bodystring or nullRequired

The comment's text body.

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

remote_idstring or nullOptional

The third-party API ID of the matching object.

userstring or nullOptionalformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

bodystring or nullRequired

The comment's text body.

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

remote_idstring or nullOptional

The third-party API ID of the matching object.

userstring or nullOptionalformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

bodystring or nullRequired

The comment's text body.

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

remote_idstring or nullOptional

The third-party API ID of the matching object.

userstring or nullOptionalformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

is_privateboolean or nullOptional

Whether or not the comment is internal.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

html_bodystring or nullRequired

The comment's text body formatted as html.

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

remote_idstring or nullOptional

The third-party API ID of the matching object.

userstring or nullOptionalformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

is_privateboolean or nullOptional

Whether or not the comment is internal.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

bodystring or nullRequired

The comment's text body.

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

remote_idstring or nullOptional

The third-party API ID of the matching object.

userstring or nullOptionalformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

is_privateboolean or nullOptional

Whether or not the comment is internal.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

bodystring or nullRequired

The comment's text body.

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

remote_idstring or nullOptional

The third-party API ID of the matching object.

userstring or nullOptionalformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

remote_idstring or nullOptional

The third-party API ID of the matching object.

userstring or nullOptionalformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

contactstring or nullOptionalformat: "uuid"

The author of the Comment, if the author is a Contact.If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

bodystring or nullOptional

The comment's text body.

html_bodystring or nullOptional

The comment's text body formatted as html.

is_privateboolean or nullOptional

Whether or not the comment is internal.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

bodystring or nullRequired

The comment's text body.

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

remote_idstring or nullOptional

The third-party API ID of the matching object.

userstring or nullOptionalformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

remote_created_atdatetime or nullOptional

When the third party's comment was created.

Supported POST model parameters

ticketstring or nullRequiredformat: "uuid"

The ticket associated with the comment.

is_privateboolean or nullRequired

Whether or not the comment is internal.

remote_idstring or nullOptional

The third-party API ID of the matching object.

userstring or nullOptionalformat: "uuid"

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of {name}]” to the comment.

1	import { MergeClient } from "@mergeapi/merge-node-client";
2
3	const client = new MergeClient({ apiKey: "YOUR_API_KEY", accountToken: "YOUR_ACCOUNT_TOKEN" });
4	await client.ticketing.comments.create({
5	isDebugMode: true,
6	runAsync: true,
7	model: {}
8	});

1	{
2	"model": {
3	"id": "0958cbc6-6040-430a-848e-aafacbadf4ae",
4	"remote_id": "19202938",
5	"created_at": "2021-09-15T00:00:00Z",
6	"modified_at": "2021-10-16T00:00:00Z",
7	"user": "17a54124-287f-494d-965e-3c5b330c9a68",
8	"contact": "dde3fb16-b8eb-483d-81c4-b78100816f15",
9	"body": "When will these integrations be done? You all should use Merge.",
10	"html_body": "When will these integrations be done? You all should use <b>Merge<b>.",
11	"ticket": "fb8c55b6-1cb8-4b4c-9fb6-17924231619d",
12	"is_private": true,
13	"remote_created_at": "1990-11-10T00:00:00Z",
14	"remote_was_deleted": true,
15	"field_mappings": {
16	"organization_defined_targets": {
17	"custom_key": "custom_value"
18	},
19	"linked_account_defined_targets": {
20	"custom_key": "custom_value"
21	}
22	},
23	"remote_data": [
24	{
25	"path": "/platform-endpoint"
26	}
27	]
28	},
29	"warnings": [
30	{
31	"title": "Unrecognized Field",
32	"detail": "An unrecognized field, age, was passed in with request data.",
33	"problem_type": "UNRECOGNIZED_FIELD",
34	"source": {
35	"pointer": "/age"
36	},
37	"block_merge_link": true
38	}
39	],
40	"errors": [
41	{
42	"title": "Missing Required Field",
43	"detail": "custom_fields is a required field on model.",
44	"problem_type": "MISSING_REQUIRED_FIELD",
45	"source": {
46	"pointer": "/model/custom_fields"
47	},
48	"block_merge_link": true
49	}
50	],
51	"logs": [
52	{
53	"log_id": "99433219-8017-4acd-bb3c-ceb23d663832",
54	"dashboard_view": "https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832",
55	"log_summary": {
56	"url": "www.exampleintegration.com/api/v1/exampleapi",
57	"method": "POST",
58	"status_code": 200
59	}
60	}
61	]
62	}

Authentication

Headers

Query parameters

Request

Description

Usage Example

Response

Description

Usage Example

Field support by integration

Field support by integration