Update contact with the Freshdesk API

Updates a contact: send only the fields to change, and tags and other_emails as the full lists the contact should keep. Blocked or deleted contacts return 405.

Identifier
freshdesk_update_contact

The request

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

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "contact_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
contact_idintegerYesId of the contact, from List contacts or the requester_id of a ticket.
namestringNoName of the contact.
emailstringNoPrimary email address, unique among contacts.
phonestringNoTelephone number.
mobilestringNoMobile number.
unique_external_idstringNoExternal id of the contact, the id in your own system, unique among contacts.
other_emailsarrayNoFull list of additional email addresses the contact should have, current ones included.
company_idintegerNoId of the primary company of the contact, from Search companies.
view_all_ticketsbooleanNotrue lets the contact see all the tickets of the company.
job_titlestringNoJob title.
addressstringNoAddress.
descriptionstringNoShort description of the contact.
languagestringNoLanguage code. Only with the Multiple Language feature.
time_zonestringNoTime zone name. Only with the Multiple Time Zone feature.
tagsarrayNoFull list of tags the contact should have, current ones included.
custom_fieldsobjectNoCustom field values keyed by the name of each contact custom field, as they appear in custom_fields of List contacts. 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_contact. 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.