JSON API » people » people/zohocrm/create

Creates a new Zoho CRM user integration. This method should be called after the user is approved for OAuth by Zoho CRM.

Input parameters

Requires authentication and the user role privilege, or administrator role if the object is not owned by the user.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
codeStringAuthorization code provided by Zoho CRM OAuth.Yes
locationStringLocation provided by Zoho CRM OAuth. Can be "au", "eu", "in", or "us".Yes
hostStringOAuth redirect URL approved for use by Zoho CRM, ending with "/users/users/zohocrm".Yes
stateIntegerID of user to integrate with Zoho CRM.Yes

Responses

CodeDescription
200Success.
400Invalid input parameters specified. Check the key and message fields for more details.
401The authentication details provided are invalid.
402Your role does not allow this.
500Zoho CRM returned an error message.

Data returned

No data is returned.

Example: With required and recommended parameters

http://enswitch.example.com/api/json/people/zohocrm/create/?auth_username=user;auth_password=password;code=SECRET;location=us;host=http://enswitch.example.com/users/users/zohocrm;state=123

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ] }

Change history

VersionChanges
4.4Function added.