• Documentation
    • Search documentation
    karat

    +

    K

    API Reference ↗
    Data connectivity & integrationAvailable connectorsZoho CRM

    Zoho CRM

    The Zoho CRM connector is a Palantir-provided driver for Zoho CRM.

    To create a new Zoho CRM source, follow the standard setup flow for Palantir-provided drivers, then use the sections below for Zoho CRM-specific configuration and networking. For the complete property reference, see the official Zoho CRM driver documentation ↗.

    Supported capabilities

    CapabilityStatus
    Exploration🟢 Generally available
    Batch syncs🟢 Generally available
    Incremental🟢 Generally available
    OAuth 2.0 authentication🟢 Generally available
    Table exports🟢 Generally available

    Configuration

    The properties below are mandatory or recommended.

    PropertyRequired?DescriptionDefault
    Schema ↗MandatorySpecifies the Zoho CRM version the provider retrieves data from. Each version has a corresponding data model.v4
    InitiateOAuth ↗RecommendedSpecifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working.REFRESH
    OAuthClientId ↗RecommendedSpecifies the client Id that was assigned when the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.—
    OAuthClientSecret ↗RecommendedSpecifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret). This secret registers the custom application with the OAuth authorization server.—
    Region ↗RecommendedThe Top Level Domain (TLD) in the server URL.US
    UseCOQL ↗RecommendedWhen true, the provider uses the Query API to retrieve data.TRUE

    Networking

    The table below lists the domains that the source must be able to access to run.

    For each domain, add a corresponding egress policy. If the source is hosted on-premises and not directly reachable from Foundry, use an agent proxy egress policy instead. The agent host itself must also be able to reach the listed domains. See using an agent as a proxy for details.

    DomainRequired
    <APIDomain> - default: zohoapis.<Region>Always. If UseSandbox=FALSE (default), Region connection property maps to TLD (default Region=US --> .com); APIDomain can be used when manually setting OAuthAccessToken
    sandbox.zohoapis.<Region>If UseSandbox=TRUE
    <AccountsServer> - default: accounts.zoho.<Region>Always. Retrieved automatically with OAuth flow; set in AccountsServer connection property when manually providing OAuthAccessToken

    Region mappings

    Use the following region mapping to complete the domain URL:

    RegionEndpoint
    US.com
    Europe.eu
    India.in
    Australia.com.au
    Japan.jp
    China.com.cn

    OAuth 2.0 authentication

    This connector supports OAuth 2.0 authentication. Follow the OAuth 2.0 guidance for Palantir-provided drivers to configure and authorize the connection.

    Table exports

    This connector supports table exports. Learn how to set up a table export.