Update ticket with the Freshdesk API

Updates a ticket: send only the fields to change, and tags as the full list the ticket should keep. Status 4 resolves and 5 closes it, and closing needs the fields marked required_for_closure in List ticket fields. Spam or deleted tickets return 405, and outbound tickets keep their subject and description.

Identifier
freshdesk_update_ticket

The request

POST https://connect.reportei.com/api/tools/freshdesk_update_ticket/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
  }
}

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.
requester_idintegerNoId of an existing contact as the new requester, from List contacts.
emailstringNoEmail address of the new requester. A new address creates the contact.
phonestringNoPhone number of the new requester. A new number creates the contact, and without email the name becomes mandatory.
unique_external_idstringNoExternal id of the new requester, the id in your own system. A new id creates the contact.
namestringNoName of the requester.
subjectstringNoSubject of the ticket.
descriptionstringNoContent of the ticket, as HTML or plain text.
statusintegerNo2 Open, 3 Pending, 4 Resolved or 5 Closed. Custom statuses of the helpdesk are the choices of the status field in List ticket fields.
priorityintegerNo1 Low, 2 Medium, 3 High or 4 Urgent.Values: 1, 2, 3, 4
sourceintegerNoChannel of the ticket: 1 Email, 2 Portal, 3 Phone, 7 Chat, 9 Feedback widget or 10 Outbound email.Values: 1, 2, 3, 7, 9, 10
typestringNoTicket type, one of the choices of the ticket_type field in List ticket fields, such as Question or Incident.
responder_idintegerNoId of the agent to assign the ticket to, from the choices of the agent field in List ticket fields.
group_idintegerNoId of the group to assign the ticket to, from the choices of the group field in List ticket fields.
product_idintegerNoId of the product of the ticket, from the choices of the product field in List ticket fields.
company_idintegerNoId of the company of the requester, from Search companies. Only with the Multiple Companies feature.
tagsarrayNoFull list of tags the ticket should have, current ones included.
due_bystringNoWhen the ticket is due to be resolved.
fr_due_bystringNoWhen the first response is due.
custom_fieldsobjectNoCustom field values keyed by the name of each custom field in List ticket fields, for example cf_order_number. Dates go as YYYY-MM-DD.

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_update_ticket. 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.