freshworks-api
v1.4.1
Published
Provides a series of methods for interacting with the Freshworks CRM REST api.
Downloads
37
Maintainers
Readme
Provides a series of methods for interacting with the Freshworks CRM REST api.
Contributions welcome.
Install
yarn install freshworks-api
Use
const sdk = new FreshWorksCrm({authToken: <your freshworks api token here>, freshworksSubdomain: <your freshworks CRM subdomain here>});
let contacts = sdk.searchForContacts('search query');
let singleContact = sdk.getContact('contact-id');
let newContact = sdk.createContact({});
let updatedContact = sdk.updateContact({});
let accounts = sdk.searchForAccounts('search query');
let newAccount = sdk.createAccount({});
let updatedAccount = sdk.updateAccount({});
let deals = sdk.searchForDeals('search query');
let singleDeal = sdk.getDeal('deal-id');
let newDeal = sdk.createDeal({});
let updatedDeal = sdk.updateDeal({});
let newNote = sdk.createNote({})
Author
👤 Edmund Munday [email protected]
- Website: http://need2know.io
Show your support
Give a ⭐️ if this project helped you!
This README was generated with ❤️ by readme-md-generator