Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add possible config params description #58

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add possible config params description #58

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 30 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,12 @@ Currently a WIP, but feel free to ask how you can help.
```
var Zoho = require('node-zoho');

var zoho = new Zoho({authToken:'API-TOKEN'});
var config = {
authToken: 'API-TOKEN',
// region: 'eu',//default is 'com'
};

var zoho = new Zoho(config);
var records = [
{
"Lead Source" : "Site Registration",
Expand All @@ -293,6 +298,30 @@ var callback = function (err, result) {

```

# Possible Zoho config parameters

<table>
<header>
<tr>
<th>Parameter Name</th>
<th>Descripion</th>
<th>Default value</th>
</tr>
</header>
<body>
<tr>
<td>authToken</td>
<td>Your CRM user authtoken</td>
<td></td>
</tr>
<tr>
<td>region</td>
<td>Zoho CRM region. Possible values: 'com', 'eu'</td>
<td>com</td>
</tr>
</body>
</table>

# Contribute

All the code is coffescript, but we deploy compiled js to npm. If you want to help, checkout the git repo and submit a PR.
Expand Down