Skip to main content
POST
Create a draft comment for a ticket
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.

Path Parameters

ticket_id
string
required

ID of the ticket. You can use either the ticket ID (UUID) or ticket number (sequential number) interchangeably. Refer to Getting Ticket ID section for detailed instructions.

Body

application/json
content
string
required

Content for the draft comment. Cannot be blank.

Example:

"We are looking into the issue."

comment_type
enum<string>

Type of the comment. Defaults to reply.

Available options:
reply,
note
Example:

"note"

author_email
string

Optional email address of the person creating the draft. If provided, the signature stored in NeetoDesk for this user will be appended to the draft.

Example:

"oliver@example.com"

attachments
string[]

Signed ids returned by Upload attachment or Reserve an attachment upload. The ids are kept on the draft and are not attached to anything until the draft is sent. A signed id minted in another workspace is rejected, and so is one whose file was reserved but never sent. Attachments are all-or-nothing: if any id in the array is unknown, malformed, unsent or from another workspace, the whole request fails and the draft is unchanged. Passing this replaces the ids the draft already held; omit it to leave them as they are, or pass an empty array to clear them. Attaching the draft's files when it is sent applies the workspace attachment limit, 10 MB by default.

Example:

Response

201 - application/json

Created - Draft created successfully

draft
object