ContactsApi

All URIs are relative to https://freshdesk.com/api/v2

MethodHTTP requestDescription
cancelContactImportPUT /contacts/imports/{id}/cancelCancel contact import
createContactPOST /contactsAdd a Contact
deleteContactDELETE /contacts/{id}Delete a Contact
exportContactsPOST /contacts/exportExport contacts
getAllContactsGET /contactsGet all Contacts
getContactGET /contacts/{id}Get a contact
getContactFieldsGET /contact_fieldsGet Contact Fields
getContactImportDetailsGET /contacts/imports/{id}Get contact import's details
getExportedContactGET /contacts/export/{id}Get exported contact
getImportedContactsGET /contacts/importsGet imported contacts details
hardDeleteContactDELETE /contacts/{id}/hard_deleteHard delete a Contact
importContactPOST /contacts/importsImport contact
inviteContactPUT /contacts/{id}/send_inviteSend Invite to a Contact
makeAgentPUT /contacts/{id}/make_agentConvert Contact to an Agent
mergeContactsPOST /contacts/mergeMerge two contacts
restoreContactPUT /contacts/{id}/restoreRestore a Contact
searchContactsGET /search/contactssearch Contacts
updateContactPUT /contacts/{id}Update a contact

cancelContactImport

Cancel contact import

Method syntax: ContactImportDetails cancelContactImport(id)

Parameters

NameTypeDescriptionNotes
idString

Return type

ContactImportDetails

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

createContact

Add a Contact

Method syntax: Contact createContact(contact)

Parameters

NameTypeDescriptionNotes
contactContact

Return type

Contact

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json, multipart/form-data
  • Accept: application/json

deleteContact

Delete a Contact

Method syntax: deleteContact(id)

Parameters

NameTypeDescriptionNotes
idNumber

Return type

null (empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

exportContacts

Export contacts

Method syntax: InlineResponse200 exportContacts(contactMergeInput)

Parameters

NameTypeDescriptionNotes
contactMergeInputContactsExport

Return type

InlineResponse200

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getAllContacts

Get all Contacts

Method syntax: [Contact] getAllContacts(opts)

Parameters

NameTypeDescriptionNotes
emailString[optional]
mobileString[optional]
phoneString[optional]
companyIdString[optional]
stateString[optional]
updatedSinceString[optional]
perPageNumber[optional]

Return type

[Contact]

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getContact

Get a contact

Method syntax: Contact getContact(id)

Parameters

NameTypeDescriptionNotes
idNumber

Return type

Contact

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getContactFields

Get Contact Fields

Method syntax: [ContactField] getContactFields()

Parameters

This endpoint does not need any parameter.

Return type

[ContactField]

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getContactImportDetails

Get contact import's details

Method syntax: ContactImportDetails getContactImportDetails(id)

Parameters

NameTypeDescriptionNotes
idString

Return type

ContactImportDetails

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getExportedContact

Get exported contact

Method syntax: ExportedContact getExportedContact(id)

Parameters

NameTypeDescriptionNotes
idString

Return type

ExportedContact

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getImportedContacts

Get imported contacts details

Method syntax: [ContactImportDetails] getImportedContacts(opts)

Parameters

NameTypeDescriptionNotes
statusString[optional]

Return type

[ContactImportDetails]

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

hardDeleteContact

Hard delete a Contact

Method syntax: hardDeleteContact(id)

Parameters

NameTypeDescriptionNotes
idNumber

Return type

null (empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

importContact

Import contact

Method syntax: ContactImportDetails importContact(file, fieldsName, fieldsEmail, fieldsCompanyName)

Parameters

NameTypeDescriptionNotes
fileFile
fieldsNameString
fieldsEmailString
fieldsCompanyNameString

Return type

ContactImportDetails

Authorization

basicAuth

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

inviteContact

Send Invite to a Contact

Method syntax: inviteContact(id)

Parameters

NameTypeDescriptionNotes
idNumber

Return type

null (empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

makeAgent

Convert Contact to an Agent

Method syntax: MakeAgentResponse makeAgent(id, opts)

Parameters

NameTypeDescriptionNotes
idNumber
makeAgentMakeAgentRequest[optional]

Return type

MakeAgentResponse

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

mergeContacts

Merge two contacts

Method syntax: mergeContacts(contactMergeInput)

Parameters

NameTypeDescriptionNotes
contactMergeInputContactMergeInput

Return type

null (empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

restoreContact

Restore a Contact

Method syntax: restoreContact(id)

Parameters

NameTypeDescriptionNotes
idNumber

Return type

null (empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

searchContacts

search Contacts

Method syntax: ContactSearch searchContacts(opts)

Parameters

NameTypeDescriptionNotes
queryString[optional]

Return type

ContactSearch

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

updateContact

Update a contact

Method syntax: Contact updateContact(id, contact)

Parameters

NameTypeDescriptionNotes
idNumber
contactContact

Return type

Contact

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json
Last Updated: