Skip to content
POST /unified/ticketing/comments

Query Parameters

Refer Specifying query parameters in Truto APIs

workspace_idstring

The work item's project (id or name). Optional: when missing, the project is read from the work item first.

1 supported
Azure DevOps
supported
ticketobject

Set either ticket or collections.

References: Tickets → id
9 supported6 required
Dixa
required
Hive
required
SolarWinds Service Desk
required
SurveySparrow Ticket Management
required
Wrike
required
Zoho Projects
required
Enchant
supported
Pivotal Tracker
supported
Re:amaze
supported
idstring
required·

The unique identifier for a ticket

ownerstring

The GitHub user or organization that owns the repository.

1 supported
GitHub
supported
repostring

The repository name.

1 supported
GitHub
supported
workspacestring

The repository as owner/repo, the id returned by workspaces. Use it in place of owner and repo.

2 supported1 required
Zoho Projects
required
GitHub
supported
ticket_idstring

The unique identifier for a ticket

1 supported1 required
Help Scout
required
collections

Collection with type epic is required.

1 supported
Pivotal Tracker
supported
idstring

The unique identifier for a collection.

organizationobject
1 supported
Zoho Projects
supported
idstring
required·

The unique identifier for a organization.

Show Truto-specific parameters
integrated_account_idstring · uuid
required·

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_formatstring

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.
  • debug returns the final unified result alongside raw remote fetch information. The response is an envelope containing result (identical to unified mode output) and debug (with requestUrl, requestOptions, data, responseHeaders, and for list operations: nextCursor, isLooping, isEmptyResult, resultCount). When the upstream body exceeds 1 MiB, data is replaced by { truto_truncated: true, truto_max_bytes, truto_excerpt }. debug is null for static responses or when truto_skip_api_call=true. An integrated account token that cannot read credentials (the kind the connect flow gives a browser) gets a 403 for debug.

Defaults to unified.

Example: unified
Possible values:
unifiedrawnormalizedstreamdebug
truto_ignore_remote_databoolean

Excludes the remote_data attribute from the response.

truto_enforce_write_schemaboolean

Validates the request body against this method's request_body_schema before the request is sent to the underlying integration. When a field marked required is missing, Truto responds 400 with the missing field names under truto_error_insight.missing_required_body_fields instead of forwarding the call. Only the fields documented in request_body_schema are checked. A body carrying a non-empty remote_data object is forwarded unchecked, because remote_data is merged into the provider request and may already carry the required values. A field the mapping always supplies through its default body is treated as present, and a field that is only conditionally required is reported under truto_error_insight.conditionally_required_body_fields rather than rejected. Some integrations declare fields required on update that the provider only requires on create; check meta/{method} for the resource before enabling this on update calls. If you sent an Idempotency-Key and the request was rejected, use a fresh key when you retry with a corrected body: the idempotency cache is keyed on the integrated account, path and key only — it ignores the query string and the body — so reusing the key replays the rejection. Defaults to false, which forwards the request as-is.

truto_exclude_fieldsstring[]

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_queryRecord<string, any>

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar

Request Body

Refer Writing data using Unified APIs

attachmentsobject[]

Optional list of attachments to be attached to this thread.

11 supported
Dixa
supported
Enchant
supported
GitHub
supported
Hive
supported
Monday.com
supported
Re:amaze
supported
SolarWinds Service Desk
supported
SurveySparrow Ticket Management
supported
Todoist
supported
Wrike
supported
Zoho Projects
supported
content_typestring
required·

The mime type of the file

datastring
required·

The base64 encoded data of the file

file_namestring
required·

The name of the file

created_atstring · date-time

The time when the attachment was created

file_urlstring

The URL to download the attachment

idstring

The unique identifier for the attachment

uploaded_byobject

The user who uploaded the attachment

2 properties
idstring

The user who uploaded the attachment

namestring

The user who uploaded the attachment

uploaded_by_typestring

The type of the user who uploaded the attachment

authorobject

The id of the user or contact who created the comment

14 supported1 required
Enchant
required
Azure DevOps
supported
Dixa
supported
GitHub
supported
Hive
supported
Jira
supported
Jira Service Management
supported
Monday.com
supported
Pivotal Tracker
supported
Re:amaze
supported
SolarWinds Service Desk
supported
SurveySparrow Ticket Management
supported
Wrike
supported
Zoho Projects
supported
idstring
required·

Unique identifier of the user. Required if type is "user".

typestring
required·

Type of the author

Possible values:
usercontactsystemusercontact
emailsobject[]

Required if type is set to "contact"

1 property
emailstring

Email address of the contact

namestring

The name of the user or contact who created the comment

usernamestring

The username of the user or contact who created the comment

bccstring[]

Collection of strings representing email addresses.

1 supported
Help Scout
supported
bodystring

Comment text (Markdown is converted to HTML). Used when html_body is not sent.

15 supported11 required
Dixa
required
GitHub
required
Help Scout
required
Jira
required
Pivotal Tracker
required
Re:amaze
required
SolarWinds Service Desk
required
SurveySparrow Ticket Management
required
Todoist
required
Wrike
required
Zoho Projects
required
Azure DevOps
supported
Enchant
supported
Jira Service Management
supported
Monday.com
supported
ccstring[]

Collection of strings representing email addresses.

1 supported
Help Scout
supported
channelobject

The medium through which the comment was sent.

1 supported
Dixa
supported
idstring

The unique identifier for the channel

namestring

The name of the channel

typestring

The type of the channel

collections

Either ticket or collections is required.

1 supported
Todoist
supported
contact

Required if creating an outbound reply.

1 supported
Enchant
supported
emailsobject[]
1 property
emailstring

Email address of the contact

contact_idstring

The id of the contact who created the comment.

1 supported1 required
Help Scout
required
created_atstring · date-time

The date and time when the comment was created

15 supported
Azure DevOps
supported
Dixa
supported
Enchant
supported
GitHub
supported
Hive
supported
Jira
supported
Jira Service Management
supported
Monday.com
supported
Pivotal Tracker
supported
Re:amaze
supported
SolarWinds Service Desk
supported
SurveySparrow Ticket Management
supported
Todoist
supported
Wrike
supported
Zoho Projects
supported
custom_fields
1 supported
Quickbase for Project Management
supported
draftboolean

If set to true, a draft reply is created.

1 supported
Help Scout
supported
html_bodystring

Comment as HTML. Wins over body.

7 supported1 required
Hive
required
Dixa
supported
Enchant
supported
Jira
supported
Jira Service Management
supported
Monday.com
supported
Re:amaze
supported
importedboolean

The imported field enables thread to be created for historical purposes (i.e. if moving from a different platform, you can import your history). When imported is set to true, no outgoing emails or notifications will be generated.

1 supported
Help Scout
supported
is_internalboolean

Set this value as true if the comment is internal note.

Possible values:
true
3 supported
Re:amaze
supported
true
Dixa
supported
Enchant
supported
is_privateboolean

true makes it an internal comment (agents only). Default: public, visible to the customer.

4 supported
Jira
supported
Jira Service Management
supported
SolarWinds Service Desk
supported
SurveySparrow Ticket Management
supported
receiverobject

The id of the user or contact who is receiving the comment

2 supported1 required
Gorgias
required
Re:amaze
supported
idstring
required·

The id of the user or contact who receiving the comment

typestring
required·

Type of the receiver

Possible values:
usercontactsystem
namestring

The name of the user or contact who receiving the comment

remote_dataRecord<string, any>

Any additional data that should be passed as part of the request body. This data is not transformed by Truto and is passed as is to the remote API.

statusstring

Use this field to change conversation status when adding a thread. If not explicitly set, a reply thread will reactivate the conversation.

1 supported
Help Scout
supported
subjectstring

The subject of the comment

1 supported
Gorgias
supported
ticketobject

Either ticket or collections is required.

References: Tickets → id
15 supported5 required
Azure DevOps
required
GitHub
required
Jira
required
Jira Service Management
required
Monday.com
required
Dixa
supported
Enchant
supported
Hive
supported
Pivotal Tracker
supported
Re:amaze
supported
SolarWinds Service Desk
supported
SurveySparrow Ticket Management
supported
Todoist
supported
Wrike
supported
Zoho Projects
supported
idstring
required·

The unique identifier for a ticket

user_idstring

ID of the user who is adding the thread. The resource owner is the default when not set.

1 supported
Help Scout
supported

Response Body

idstring
required·

The unique identifier for a comment

16 supported
Azure DevOps
supported
Dixa
supported
Enchant
supported
GitHub
supported
Hive
supported
Jira
supported
Jira Service Management
supported
Monday.com
supported
Pivotal Tracker
supported
Quickbase for Project Management
supported
Re:amaze
supported
SolarWinds Service Desk
supported
SurveySparrow Ticket Management
supported
Todoist
supported
Wrike
supported
Zoho Projects
supported
attachmentsobject[]

The attachments of the comment

11 supported
Dixa
supported
Enchant
supported
GitHub
supported
Hive
supported
Monday.com
supported
Re:amaze
supported
SolarWinds Service Desk
supported
SurveySparrow Ticket Management
supported
Todoist
supported
Wrike
supported
Zoho Projects
supported
content_typestring

The content type of the attachment

created_atstring · date-time

The time when the attachment was created

file_namestring

The attachment's name.

file_urlstring

The URL to download the attachment

idstring

The unique identifier for the attachment

uploaded_byobject

The user who uploaded the attachment

2 properties
idstring

The user who uploaded the attachment

namestring

The user who uploaded the attachment

uploaded_by_typestring

The type of the user who uploaded the attachment

authorobject

The id of the user or contact who created the comment

14 supported
Azure DevOps
supported
Dixa
supported
Enchant
supported
GitHub
supported
Hive
supported
Jira
supported
Jira Service Management
supported
Monday.com
supported
Pivotal Tracker
supported
Re:amaze
supported
SolarWinds Service Desk
supported
SurveySparrow Ticket Management
supported
Wrike
supported
Zoho Projects
supported
idstring
required·

The id of the user or contact who created the comment

typestring
required·

Type of the author

Possible values:
usercontactsystem
namestring

The name of the user or contact who created the comment

usernamestring

The username of the user or contact who created the comment

bodystring

The body of the comment

14 supported
Azure DevOps
supported
Dixa
supported
Enchant
supported
GitHub
supported
Jira
supported
Jira Service Management
supported
Monday.com
supported
Pivotal Tracker
supported
Re:amaze
supported
SolarWinds Service Desk
supported
SurveySparrow Ticket Management
supported
Todoist
supported
Wrike
supported
Zoho Projects
supported
channelobject

The medium through which the comment was sent.

1 supported
Dixa
supported
idstring

The unique identifier for the channel

namestring

The name of the channel

typestring

The type of the channel

created_atstring · date-time

The date and time when the comment was created

15 supported
Azure DevOps
supported
Dixa
supported
Enchant
supported
GitHub
supported
Hive
supported
Jira
supported
Jira Service Management
supported
Monday.com
supported
Pivotal Tracker
supported
Re:amaze
supported
SolarWinds Service Desk
supported
SurveySparrow Ticket Management
supported
Todoist
supported
Wrike
supported
Zoho Projects
supported
etagstring

The unique identifier for the specific version of the resource.

html_bodystring

The body of the comment in HTML format

7 supported
Dixa
supported
Enchant
supported
Hive
supported
Jira
supported
Jira Service Management
supported
Monday.com
supported
Re:amaze
supported
is_internalboolean

Whether the comment is internal. True for internal notes left by users.

3 supported
Dixa
supported
Enchant
supported
Re:amaze
supported
is_privateboolean

Whether the comment is private or not

4 supported
Jira
supported
Jira Service Management
supported
SolarWinds Service Desk
supported
SurveySparrow Ticket Management
supported
receiverobject

The id of the user or contact who is receiving the comment

1 supported
Re:amaze
supported
idstring
required·

The id of the user or contact who receiving the comment

typestring
required·

Type of the receiver

Possible values:
usercontactsystem
namestring

The name of the user or contact who receiving the comment

remote_dataRecord<string, any>

Raw data returned from the remote API call.

ticketobject

The ticket to which the comment belongs

References: Tickets → id
15 supported
Azure DevOps
supported
Dixa
supported
Enchant
supported
GitHub
supported
Hive
supported
Jira
supported
Jira Service Management
supported
Monday.com
supported
Pivotal Tracker
supported
Re:amaze
supported
SolarWinds Service Desk
supported
SurveySparrow Ticket Management
supported
Todoist
supported
Wrike
supported
Zoho Projects
supported
idstring
required·

The unique identifier for a ticket

updated_atstring · date-time

The date and time when the comment was updated

9 supported
Azure DevOps
supported
GitHub
supported
Jira
supported
Jira Service Management
supported
Monday.com
supported
Pivotal Tracker
supported
SolarWinds Service Desk
supported
Wrike
supported
Zoho Projects
supported
truto unified ticketing comments \
  -m create \
  -a '<integrated_account_id>' \
  -b '{
  "ticket": {},
  "body": "your_body",
  "html_body": "your_html_body",
  "author": {},
  "is_internal": true,
  "attachments": [],
  "channel": {},
  "created_at": "your_created_at",
  "receiver": {},
  "subject": "your_subject",
  "draft": true,
  "contact_id": "your_contact_id",
  "user_id": "your_user_id",
  "imported": true,
  "status": "your_status",
  "cc": [],
  "bcc": [],
  "is_private": true,
  "remote_data": {}
}' \
  -o json
import Truto from '@truto/truto-ts-sdk';

const truto = new Truto({
  token: '<your_api_token>',
});

const result = await truto.unifiedApi.create(
  'ticketing',
  'comments',
  {
  "ticket": {},
  "body": "your_body",
  "html_body": "your_html_body",
  "author": {},
  "is_internal": true,
  "attachments": [],
  "channel": {},
  "created_at": "your_created_at",
  "receiver": {},
  "subject": "your_subject",
  "draft": true,
  "contact_id": "your_contact_id",
  "user_id": "your_user_id",
  "imported": true,
  "status": "your_status",
  "cc": [],
  "bcc": [],
  "is_private": true,
  "remote_data": {}
},
  { integrated_account_id: '<integrated_account_id>' }
);

console.log(result);
import asyncio
from truto_python_sdk import TrutoApi

truto_api = TrutoApi(token="<your_api_token>")

async def main():
    result = await truto_api.unified_api.create(
        "ticketing",
        "comments",
        {
        "ticket": {},
        "body": "your_body",
        "html_body": "your_html_body",
        "author": {},
        "is_internal": True,
        "attachments": [],
        "channel": {},
        "created_at": "your_created_at",
        "receiver": {},
        "subject": "your_subject",
        "draft": True,
        "contact_id": "your_contact_id",
        "user_id": "your_user_id",
        "imported": True,
        "status": "your_status",
        "cc": [],
        "bcc": [],
        "is_private": True,
        "remote_data": {}
},
        {"integrated_account_id": "<integrated_account_id>"}
    )
    print(result)

asyncio.run(main())
curl -X POST 'https://api.truto.one/unified/ticketing/comments?integrated_account_id=<integrated_account_id>' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "ticket": {},
  "body": "your_body",
  "html_body": "your_html_body",
  "author": {},
  "is_internal": true,
  "attachments": [],
  "channel": {},
  "created_at": "your_created_at",
  "receiver": {},
  "subject": "your_subject",
  "draft": true,
  "contact_id": "your_contact_id",
  "user_id": "your_user_id",
  "imported": true,
  "status": "your_status",
  "cc": [],
  "bcc": [],
  "is_private": true,
  "remote_data": {}
}'
const integratedAccountId = '<integrated_account_id>';

const body = {
  "ticket": {},
  "body": "your_body",
  "html_body": "your_html_body",
  "author": {},
  "is_internal": true,
  "attachments": [],
  "channel": {},
  "created_at": "your_created_at",
  "receiver": {},
  "subject": "your_subject",
  "draft": true,
  "contact_id": "your_contact_id",
  "user_id": "your_user_id",
  "imported": true,
  "status": "your_status",
  "cc": [],
  "bcc": [],
  "is_private": true,
  "remote_data": {}
};

const response = await fetch(`https://api.truto.one/unified/ticketing/comments?integrated_account_id=${integratedAccountId}`, {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer <your_api_token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(body),
});

const data = await response.json();
console.log(data);
import requests

url = "https://api.truto.one/unified/ticketing/comments"
headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json",
}
params = {
    "integrated_account_id": "<integrated_account_id>"
}
payload = {
    "ticket": {},
    "body": "your_body",
    "html_body": "your_html_body",
    "author": {},
    "is_internal": True,
    "attachments": [],
    "channel": {},
    "created_at": "your_created_at",
    "receiver": {},
    "subject": "your_subject",
    "draft": True,
    "contact_id": "your_contact_id",
    "user_id": "your_user_id",
    "imported": True,
    "status": "your_status",
    "cc": [],
    "bcc": [],
    "is_private": True,
    "remote_data": {}
}

response = requests.post(url, headers=headers, params=params, json=payload)
print(response.json())