https://github.com/zoho/zohocrm-csharp-sdk-7.0
https://github.com/zoho/zohocrm-csharp-sdk-7.0
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/zoho/zohocrm-csharp-sdk-7.0
- Owner: zoho
- License: apache-2.0
- Created: 2024-07-05T11:32:56.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-12-03T05:45:21.000Z (over 1 year ago)
- Last Synced: 2024-12-03T05:46:27.384Z (over 1 year ago)
- Language: C#
- Size: 655 KB
- Stars: 1
- Watchers: 1
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ZOHO CRM CSHARP SDK 7.0 for API version 7
The C# SDK for Zoho CRM allows developers to easily create C# applications that can be integrated with Zoho CRM. This SDK serves as a wrapper for the REST APIs, making it easier to access and utilize the services of Zoho CRM.
Authentication to access the CRM APIs is done through OAuth2.0, and the authentication process is streamlined through the use of the C# SDK. The grant and access/refresh tokens are generated and managed within the SDK code, eliminating the need for manual handling during data synchronization between Zoho CRM and the client application.
This repository includes the C# SDK for API v7 of Zoho CRM. Check [Versions](https://github.com/zoho/zohocrm-csharp-sdk-7.0/releases) for more details on the versions of SDK released for this API version.
License
=======
Copyright (c) 2021, ZOHO CORPORATION PRIVATE LIMITED
All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
## Latest Version
- [5.0.0](/versions/5.0.0/ZohoCRM/README.md)
- Added new **page_token** param in **GetAttachmentsParam** class.
- **CadencesExecutionOperations** class method name changed(**EnrolCadences** to **EnrollCadences**).
- **CadencesExecutionOperations** class method name changed(**UnenrolCadences** to **UnenrollCadences**).
- **DealContactRolesOperations** class method name changed(**DeleteContactRoleRealation** to **DeleteContactRoleRelation**).
- **EmailRelatedRecords** **Email** class **threadId** field datatype changed(long? to string).
- Added new params **category**, **sort_by**, **sort_order**, and **filters** in **GetEmailTemplatesParam** class.
- Added new fields **referenceValue**, **dealCategory**, and **showValue** in **PickListValue** class.
- Added new field **delete** in **PickListValue** class in **Fields** API.
- Added new param **filters** in **GetInventoryTemplatesParam** class.
- Added new field **delete** in **SectionField** class in **Layouts** API.
- Added new field **delete** in **Sections** class in **Layouts** API.
- **Modules** class **displayField** field datatype changed(string to object).
- Added new method param **paramInstance** in **ModulesOperations** class **GetModules** method.
- Added new param **status** in **GetModulesParam** class.
- Added new param **type** in SearchRecordsParam class.
- Added new param **cvid** in RecordCountParam class.
- Added new params **page_token**, **page**, and **per_page** in **GetRecordLockingInformationsParam** class.
- Removed **module** param in **ScoringRulesOperations** class **GetScoringRule** method.
- Update **recordId**, **moduleAPIName** to **moduleAPIName**, **recordId** param location in **TagsOperations** class **AddTags** method.
- Update **recordId**, **moduleAPIName** to **moduleAPIName**, **recordId** param location in **TagsOperations** class **RemoveTags** method.
- Added new param **color_code** in **CreateTagsParam** class.
- **RemoveTagsFromMultipleRecordsParam** class **ids** param datatype changed(Long to String).
- Added new param **ids** in **GetTerritoriesParam** class.
- Added new param **page** and **per_page** in **GetChildTerritoryParam** class.
- Added new method param**paramInstance** in **UserGroupsOperations** class **GetAssociatedUsersCount** method.
- Added new params **filters**, **page**, and **per_page** in **GetAssociatedUsersCountParam** class.
- Handled FileStore save and update token method issue.
- Deprecated and removed API methods:
- UsersTerritories
- ValidateBeforeTransferForAllTerritories
- ValidateBeforeTransfer
- DelinkAndTransferFromAllTerritories
- DelinkAndTransferFromSpecificTerritory
- Support for the following new APIs
- AuditLogExport
- [Download Export Audit Log Result](https://www.zoho.com/crm/developer/docs/api/v7/download-export-audit-log-result.html)
- Cadences
- [Cadence API](https://www.zoho.com/crm/developer/docs/api/v7/cadences/get-cadences.html)
- DealContactRoles
- [Remove Contact Role from a Specific Deal](https://www.zoho.com/crm/developer/docs/api/v7/remove-contact-role-from-a-specific-deal.html)
- InventoryConvert
- [Convert Inventory Records](https://www.zoho.com/crm/developer/docs/api/v7/inventory-convert.html)
- InventoryMassConvert
- [Mass Convert Inventory Records](https://www.zoho.com/crm/developer/docs/api/v7/mass-inventory-convert.html)
- [Get Mass Inventory Conversion Status](https://www.zoho.com/crm/developer/docs/api/v7/mass-inventory-conversion-status-api.html)
- Layouts
- [Update Custom Layout](https://www.zoho.com/crm/developer/docs/api/v7/update-custom-layout.html)
- [Delete Custom Layout](https://www.zoho.com/crm/developer/docs/api/v7/delete-custom-layout.html)
- [Activate Custom Layout](https://www.zoho.com/crm/developer/docs/api/v7/activate-custom-layout.html)
- [Deactivate Custom Layout](https://www.zoho.com/crm/developer/docs/api/v7/deactivate-custom-layout.html)
- Modules
- [Create Custom Module](https://www.zoho.com/crm/developer/docs/api/v7/create-custom-module-api.html)
- Record
- [Get Rich Text Fields](https://www.zoho.com/crm/developer/docs/api/v7/get-rich-text-fields.html)
- RecordLockingConfiguration
- [Record Locking Configuration APIs](https://www.zoho.com/crm/developer/docs/api/v7/get-record-locking-config.html)
- [Add Record Locking Configuration](https://www.zoho.com/crm/developer/docs/api/v7/add-record-locking-config.html)
- [Update Record Locking Configuration](https://www.zoho.com/crm/developer/docs/api/v7/update-record-locking-config.html)
- [Delete Record Locking Configuration](https://www.zoho.com/crm/developer/docs/api/v7/delete-record-locking-config.html)
- RecycleBin
- [Get Recycle Bin Records](https://www.zoho.com/crm/developer/docs/api/v7/get-recycle-bin.html)
- [Delete Recycle Bin Records](https://www.zoho.com/crm/developer/docs/api/v7/del-recycle-bin-records.html)
- UserGroups
- [Associated Groups of a User](https://www.zoho.com/crm/developer/docs/api/v7/associated-groups-of-a-user.html)
- UsersTerritories
- [Remove Territories from User](https://www.zoho.com/crm/developer/docs/api/v7/remove-territories-from-user.html)
- ZiaEnrichment
- [Enrichment Configuration](https://www.zoho.com/crm/developer/docs/api/v7/zia-enrichment/get-config.html)
- [4.0.0](/versions/4.0.0/ZohoCRM/README.md)
- Updated the CADataCenter Accounts URL
- [3.0.0](/versions/3.0.0/ZohoCRM/README.md)
- Handle "text/plain" content type as file download.
- [2.0.0](/versions/2.0.0/ZohoCRM/README.md)
- Handled Error Structure in MassDeleteTags API.
- [1.0.0](/versions/1.0.0/ZohoCRM/README.md)
- C# SDK upgraded to support v7 APIs.
- C# SDK improved to support the following new APIs
- [Export Audit Log API](https://www.zoho.com/crm/developer/docs/api/v7/create-export-audit-log.html)
- [Cadence API](https://www.zoho.com/crm/developer/docs/api/v7/cadences/get-cadences.html)
- [Record Clone API](https://www.zoho.com/crm/developer/docs/api/v7/record-clone.html)
- [Duplicate Record Check API](https://www.zoho.com/crm/developer/docs/api/v7/enable-duplicate-record-check.html)
- [Data People Enrichment API](https://www.zoho.com/crm/developer/docs/api/v7/zia-enrichment/create-ppl-enrichment.html)
- [Data Org Enrichment API](https://www.zoho.com/crm/developer/docs/api/v7/zia-enrichment/get-config.html)
- [Mass Delete Tags API](https://www.zoho.com/crm/developer/docs/api/v7/mass-delete-tags.html)
- [Picklist Option API](https://www.zoho.com/crm/developer/docs/api/v7/picklist-values.html)
- [API Fetcher](https://www.zoho.com/crm/developer/docs/api/v7/list-available-rest-apis.html)
For older versions, please [refer](https://github.com/zoho/zohocrm-csharp-sdk-7.0/releases).
## Environmental Setup
C# SDK requires .NET Framework 4.6.1 or above to be set up in your development environment.
## Including the SDK in your project
You can include the SDK to your project using:
1. Install Visual Studio IDE from [Visual Studio](https://visualstudio.microsoft.com/downloads/) (if not installed).
2. C# SDK is available as a Nuget package. The ZOHOCRMSDK-7.0 assembly can be installed through the Nuget Package Manager or through the following options:
- Package Manager
```sh
Install-Package ZOHOCRMSDK-7.0 -Version 4.0.0
Install-Package MySql.Data -Version 6.9.12
Install-Package Newtonsoft.Json -Version 13.0.1
```
- .NET CLI
```sh
dotnet add package ZOHOCRMSDK-7.0 --version 4.0.0
dotnet add package Newtonsoft.Json --version 13.0.1
dotnet add package MySql.Data --version 6.9.12
```
- PackageReference
For projects that support PackageReference, copy this XML node into the project file to refer the package.
```sh
```
---
**NOTE**
> - The **access and refresh tokens are environment-specific and domain-specific**. When you handle various environments and domains such as **Production**, **Sandbox**, or **Developer** and **IN**, **CN**, **US**, **EU**, **JP**, or **AU**, respectively, you must use the access token and refresh token generated only in those respective environments and domains. The SDK throws an error, otherwise.
For example, if you generate the tokens for your Sandbox environment in the CN domain, you must use only those tokens for that domain and environment. You cannot use the tokens generated for a different environment or a domain.
> - For **Deal Contact Roles API and Records API**, you will need to provide the **ZohoCRM.settings.fields.ALL** scope along with the **ZohoCRM.modules.ALL** scope while generating the OAuthtoken. Otherwise, the system returns the **OAUTH-SCOPE-MISMATCH** error.
> - For **Related Records API**, the scopes required for generating OAuthtoken are **ZohoCRM.modules.ALL**, **ZohoCRM.settings.fields.ALL** and **ZohoCRM.settings.related_lists.ALL**. Otherwise, the system returns the **OAUTH-SCOPE-MISMATCH** error.
> - For **Mass Convert API**, you will need to provide the **ZohoCRM.settings.fields.ALL** scope along with the **ZohoCRM.mass_convert.leads.CREATE** and **ZohoCRM.mass_convert.leads.READ** scope while generating the OAuthtoken. Otherwise, the system returns the **OAUTH-SCOPE-MISMATCH** error.
---
For more details, kindly refer [here](/versions/4.0.0/ZohoCRM/README.md).