Skip to main content
POST
Create a comment for a ticket
Deprecated: This is a v1 endpoint. It will continue to work, but we recommend migrating to the v2 equivalent for improved REST compliance (correct HTTP status codes, consistent response envelopes, and hyphenated URLs).
Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Workspace subdomain.

Headers

X-Api-Key
string
default:your-api-key
required

Use the X-Api-Key header to provide your workspace API key. Refer to Authentication for more information.

Body

application/json
ticket_number
string
required

Number of the ticket for the comment. Refer to Method 2 in the Getting Ticket ID section for instructions on how to find this number.

Example:

"53"

author_email
string
required

Email address of the person creating the comment.

Example:

"lenor@example.com"

content
string
required

Content for the comment.

Example:

"We are looking into the issue."

comment_type
enum<string>

The type of the comment. Defaults to reply.

Available options:
reply,
note
Example:

"note"

Response

200 - application/json

OK - Request succeeded

notice_code
string
Example:

"comment_created_successfully"