Create ticket note with the Freshdesk API

Adds a note to a ticket. Notes are private by default, visible only to agents; with private false the requester can see it too.

Identifier
freshdesk_create_ticket_note

The request

POST https://connect.reportei.com/api/tools/freshdesk_create_ticket_note/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "ticket_id": 1,
    "body": "<body>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
ticket_idintegerYesId of the ticket, from List tickets or Search tickets.
bodystringYesContent of the note, as HTML or plain text.
privatebooleanNotrue (the default) keeps the note among agents; false makes it public.
notify_emailsarrayNoEmail addresses of the agents to notify about the note.
incomingbooleanNotrue shows the note as created from outside the helpdesk. The default is false.

Supported connections

Your customer connects their Freshdesk account once, with one of the modes below. The same connection serves every tool of the toolkit.

Username and password

Your customer enters the app credentials on a Connect screen, or your system sends them with POST /api/customer-toolkits, with no screen.

When connecting, your customer also enters {domain}: the address of their account on the app's API.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/freshdesk_create_ticket_note. It becomes your agent's tool definition with no conversion.

Other Freshdesk tools

See all 13 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.