Créer un contact avec l'API Freshdesk

Crée un contact. name est obligatoire, plus au moins un parmi email, phone, mobile ou unique_external_id.

Identifiant
freshdesk_create_contact

L'appel

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

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "name": "<name>"
  }
}

Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.

Paramètres

Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.

ParamètreTypeObligatoireDescription
namestringOuiName of the contact.
emailstringNonPrimary email address, unique among contacts.
phonestringNonTelephone number.
mobilestringNonMobile number.
unique_external_idstringNonExternal id of the contact, the id in your own system, unique among contacts.
other_emailsarrayNonAdditional email addresses of the contact.
company_idintegerNonId of the primary company of the contact, from Search companies.
view_all_ticketsbooleanNontrue lets the contact see all the tickets of the company.
job_titlestringNonJob title.
addressstringNonAddress.
descriptionstringNonShort description of the contact.
languagestringNonLanguage code, en by default. Only with the Multiple Language feature.
time_zonestringNonTime zone name, the time zone of the helpdesk by default. Only with the Multiple Time Zone feature.
tagsarrayNonTags of the contact.
custom_fieldsobjectNonCustom 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.

Connexions possibles

Votre client connecte son compte Freshdesk une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.

Identifiant et mot de passe

Votre client saisit les identifiants de l'app sur un écran de Connect, ou votre système les envoie avec POST /api/customer-toolkits, sans écran.

À la connexion, votre client indique aussi {domain} : l'adresse de son compte sur l'API de l'app.

La réponse

En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.

Prête pour les agents IA

L'input de cette tool est un JSON Schema, disponible via GET /api/tools/freshdesk_create_contact. Il devient la définition de tool de votre agent sans conversion.

Autres tools Freshdesk

Voir les 13 tools

Toolkits de la même catégorie

Voir les 100 toolkits

Voyez Connect appliqué à votre produit.

Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.