Skip to main content
POST
Reply or create internal note

Authorizations

X-Initdesk-Token
string
header
required

Path Parameters

ticket_id
string
required
organization_id
string
required

Body

next_assignee_id
integer | null
write-only
next_action
enum<string>
  • `` - (none)
  • close_and_mark_resolved - Close and Mark Resolved
  • close_and_mark_invalid - Close and Mark Invalid
  • close_and_mark_customer_inactivity - Close and Mark Customer Inactivity
  • reopen_waiting_customer - Reopen Waiting Customer
  • reopen_waiting_associate - Reopen Waiting Associate
  • close_and_mark_other - Close and Mark Other
  • report_spam - Report Spam
  • remove_from_spam - Remove from Spam
Available options:
,
close_and_mark_resolved,
close_and_mark_invalid,
close_and_mark_customer_inactivity,
reopen_waiting_customer,
reopen_waiting_associate,
close_and_mark_other,
report_spam,
remove_from_spam
content
string
content_html
string
is_visible_to_customer
boolean
external_recipient_emails
string<email>[] | null

On create with CC email routing: for customer-visible messages, a list (empty or not) sets this message's external CC snapshot only; the ticket row is not updated. Omitted or null copies the last customer-visible message's snapshot, or the ticket's creation-time list if none. Internal messages (not visible to customer) always store an empty list; this field is ignored for them. The ticket requester is always kept when a list is sent. On read: snapshot stored on this message.

Minimum string length: 1
attachment_ids
string<uuid>[]
write-only

List of attachment IDs to associate with this message.

Response

201 - application/json
id
integer
required
read-only
author
object | null
required

Legacy author object; may be deprecated for display in a future API version in favor of sender.

role
enum<string>
required
read-only
  • customer - Customer
  • cc - Cc
  • associate - Associate
  • system - System
Available options:
customer,
cc,
associate,
system
sender
object
required

Who sent the message. Shape is one of the MessageSender variants in the schema; use top-level role to select it. null when role is system, or for associate without author.

next_assignee
object | null
required
created_at
string<date-time>
required
read-only
updated_at
string<date-time>
required
read-only
attachments
object[]
required
read-only
next_action
enum<string>
  • `` - (none)
  • close_and_mark_resolved - Close and Mark Resolved
  • close_and_mark_invalid - Close and Mark Invalid
  • close_and_mark_customer_inactivity - Close and Mark Customer Inactivity
  • reopen_waiting_customer - Reopen Waiting Customer
  • reopen_waiting_associate - Reopen Waiting Associate
  • close_and_mark_other - Close and Mark Other
  • report_spam - Report Spam
  • remove_from_spam - Remove from Spam
Available options:
,
close_and_mark_resolved,
close_and_mark_invalid,
close_and_mark_customer_inactivity,
reopen_waiting_customer,
reopen_waiting_associate,
close_and_mark_other,
report_spam,
remove_from_spam
content
string
content_html
string
is_visible_to_customer
boolean
external_recipient_emails
string<email>[] | null

On create with CC email routing: for customer-visible messages, a list (empty or not) sets this message's external CC snapshot only; the ticket row is not updated. Omitted or null copies the last customer-visible message's snapshot, or the ticket's creation-time list if none. Internal messages (not visible to customer) always store an empty list; this field is ignored for them. The ticket requester is always kept when a list is sent. On read: snapshot stored on this message.