> For the complete documentation index, see [llms.txt](https://docs.sprinkledata.com/product/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sprinkledata.com/product/ingesting-your-data/pipelines/applications/zoho-crm.md). # Zoho CRM ## Pipeline Concepts Before setting up the pipeline, learn about pipeline concepts [here](/product/ingesting-your-data/pipelines.md) ## Step by Step Guide ### STEP-1: Configure Connection To learn about Connection, refer [here](/product/ingesting-your-data/pipelines.md) * Log into the Sprinkle application * Navigate to Ingest -> Connections Tab -> Setup connections -> * Select Zoho CRM * Provide all the mandatory details * *Name*: Name to identify this connection * *Advance Settings:* Refer [here](#advanced-connection-settings) * Connect to Zoho * Test Connection * Create ### STEP-2: Configure Pipeline To learn about pipeline, refer [here](/product/ingesting-your-data/pipelines.md) * Navigate to Ingest -> Pipelines Tab -> Setup sources -> * Select Zoho CRM * Provide the name -> Create * **Connection Tab**: * From the drop-down, select the name of the connection created in STEP-2 * Update ### STEP-3: Create a Dataset **Datasets Tab**: To learn about Dataset, refer [here](/product/ingesting-your-data/pipelines.md). Add a Dataset for each report/dataset that you want to integrate, providing the following details * *Report Type* (Required): Type of report * *Fields* * *Module Name*: Select from Contacts, Accounts, Deals, Activities, Campaigns, Tasks, Events, Notes, Calls * *Layouts* * *Module Name*: Select from Leads, Contacts, Accounts, Deals, Activities, Campaigns, Tasks, Events, Notes, Calls * *Modules* * *Module Name*: Select from Leads, Contacts, Deals, Activities, Campaigns, Tasks, Events, Notes, Calls * *Profiles* * *Records* (Records will be fetched incrementally on the Modified\_Time column) * *Module Name*: Select from Leads, Contacts, Accounts, Deals, Activities, Campaigns, Tasks, Events, Notes, Calls * *Roles* * *Users* * Flatten Level(Required): Select One Level or Multi Level. In one level, flattening will not be applied on complex type. They will be stored as string. In multi-level, flattening will be applied in complex level till they become simple type. * *Destination Schema* (Required): Data warehouse schema where the table will be ingested into * *Destination Table name* (Required): It is the table name to be created on the warehouse. If not given, sprinkle will create like ds\_\\_\ * *Destination Create Table Clause*: Provide additional clauses to warehouse-create table queries such as clustering, partitioning, and more, useful for optimizing DML statements. [Learn more](https://docs.sprinkledata.com/product/integrating-your-data/data-imports/destination-create-table-clause) on how to use this field. * Create ### STEP-4: Run and schedule Ingestion In the **Ingestion Jobs** tab**:** * Trigger the Job, using the Run button * To schedule, enable Auto-Run. Change the frequency if needed ### Advanced Connection Settings * **API Read Timeout (In seconds):** If reading the data takes more time than (n) seconds it will automatically timeout. * **API Connection Timeout (In seconds):** API will wait for the server to respond for (n) seconds, if the server does not respond it timeouts. * **Retry Limit:** If the API fails due to the API usage limit exceeded it will retry (n) more times. * **Retry Sleep Time (In milliseconds):** Before retrying it will wait for (n) milliseconds. * **Version:** Enter the required version. * **Max Records Per Job:** Each job will fetch maximum of (n) records for a particular dataset. ## Dataset Fields
Fields * system\_mandatory * webhook * json\_type * field\_label * created\_source * field\_read\_only * display\_label * ui\_type * read\_only * businesscard\_supported * currency * id * custom\_field * lookup * visible * length * view\_type\_view * view\_type\_edit * view\_type\_quick\_create * view\_type\_create * api\_name * unique * history\_tracking * data\_type * formula * mass\_update * multiselectlookup * pick\_list\_values * auto\_number * blueprint\_supported * pick\_list\_values * quick\_sequence\_number * lookup\_display\_label * lookup\_api\_name * lookup\_module * lookup\_id * sub\_module\_api\_name * sub\_module\_id * currency\_rounding\_option * currency\_precision * decimal\_place
Layouts * display\_label * visible * name * profiles * id * sections * status
Modules * global\_search\_supported * kanban\_view * *field\_states* * deletable * creatable * filter\_status * inventory\_template\_supported * plural\_label * presence\_sub\_menu * triggers\_supported * id * isblueprintsupported * related\_list\_properties\_fields * per\_page * *properties* * visibility * convertable * editable * emailtemplate\_support profiles * filter\_supported * display\_field * search\_layout\_fields * kanban\_view\_supported * show\_as\_tab * sequence\_number * singular\_label * viewable * api\_supported * api\_name * quick\_create * generated\_type * feeds\_required * scoring\_supported * webform\_supported * arguments * module\_name * business\_card\_field\_limit * custom\_view\_display\_value * custom\_view\_shared\_type * custom\_view\_system\_name * custom\_view\_offline * custom\_view\_default * custom\_view\_system\_defined * custom\_view\_name * custom\_view\_id * custom\_view\_category * custom\_view\_fields * parent\_module
Profiles * display\_label * name * description * id * category
Records * owner\_name * owner\_id * owner\_email * ownership * description * \_currency\_symbol * account\_type * \_review\_process\_approve * \_review\_process\_reject * \_review\_process\_resubmit * website * employees * last\_activity\_time * industry * record\_image * modified\_by\_name * modified\_by\_id * modified\_by\_email * \_state * \_process\_flow * phone * billing\_country * account\_name * id * account\_number * \_approved * \_approval\_delegate * \_approval\_approve * \_approval\_reject * \_approval\_resubmit * modified\_time * billing\_street * created\_time * \_editable * billing\_code * billing\_city * \_in\_merge * billing\_state * created\_by\_name * created\_by\_id * created\_by\_email * annual\_revenue * \_approval\_state
Roles * display\_label * share\_with\_peers * name * description * id * admin\_user * reporting\_to\_name * reporting\_to\_id
Users * country * role\_name * role\_id * customize\_info\_show\_home * customize\_info\_show\_detail\_view * name\_format * language * locale * microsoft * personal\_account * isonline * default\_tab\_group * modified\_by\_name * modified\_by\_id * theme\_normal\_tab\_font\_color * theme\_normal\_tab\_background * theme\_selected\_tab\_font\_color * theme\_selected\_tab\_background * theme\_background * theme\_screen theme\_type * id * state * country\_locale * sandboxdeveloper * first\_name * email * decimal\_separator * created\_time * modified\_time * time\_format * offset * profile\_name * profile\_id * time\_zone * created\_by\_name * created\_by\_id * zuid * confirm * full\_name * territories * date\_format * status
--- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.sprinkledata.com/product/ingesting-your-data/pipelines/applications/zoho-crm.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.