Zoho Bulk Import API

The BulkImport API from Zoho — 1 operation(s) for bulkimport.

Operations 1

GET /api/v1/bulkImport/{bulkImportId}/sampleData Get BulkImport Sample Data #

Documentation

Specifications

Code Examples

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/zoho-bulkimport-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

zoho-bulkimport-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Helpcenter Bulk Import API
  version: 1.0.0
tags:
- name: BulkImport
paths:
  /api/v1/bulkImport/{bulkImportId}/sampleData:
    get:
      tags:
      - BulkImport
      summary: Get BulkImport Sample Data
      description: This API fetches sample data for a bulk import request, including headers and sample records for specified modules.
      operationId: getBulkImportSampleData
      parameters:
      - $ref: '#/components/parameters/bulkImportId'
      - $ref: '#/components/parameters/modules'
      - $ref: ./Common.json#/components/parameters/orgId
      responses:
        '200':
          $ref: '#/components/responses/bulkImportSampleDataResponse'
        '422':
          $ref: ./Common.json#/components/responses/multipleUnprocessEntityResponse
      security:
      - oAuth2:
        - imports.CUSTOM
      x-audience:
      - external-public
components:
  parameters:
    modules:
      name: modules
      in: query
      description: Api Name of the module to be migrated, Allowed modules are @accounts@, @contacts@, @tickets@, @tasks@, @calls@, @events@, @products@, @articles@ and custom modules
      required: true
      style: form
      explode: true
      schema:
        $ref: '#/components/schemas/module'
    bulkImportId:
      name: bulkImportId
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type:
        - string
        - 'null'
        - integer
        format: int64
        pattern: ([0-9]+)
  schemas:
    module:
      type:
      - array
      - 'null'
      description: Api Name of the module to be migrated, Allowed modules are @accounts@, @contacts@, @tickets@, @tasks@, @calls@, @events@, @products@, @articles@ and custom modules
      items:
        type:
        - string
        - 'null'
        enum:
        - accounts
        - contacts
        - tickets
        - tasks
        - calls
        - events
        - products
        - articles
        maxLength: 100
        minLength: 0
      style: simple
      explode: true
  responses:
    bulkImportSampleDataResponse:
      description: bulkImportSampleDataResponse template definitions
      content:
        application/json:
          schema:
            type:
            - 'null'
            - object
            additionalProperties: false
            properties:
              importId:
                type:
                - string
                - 'null'
                maxLength: 100
                minLength: 0
              sampleData:
                type:
                - 'null'
                - array
                items:
                  $ref: ./BulkImport.json#/components/schemas/bulkImportSampleDataModule
            required:
            - importId
            - sampleData
          examples:
            Valid responses Definitions:
              value:
                importId: '5000000086001'
                sampleData:
                - headers:
                  - label: ID
                    columnKey: col1
                  - label: Product Owner
                    columnKey: col2
                  - label: Product Name
                    columnKey: col3
                  - label: Product Code
                    columnKey: col4
                  - label: Manufacturer
                    columnKey: col5
                  - label: Product Category
                    columnKey: col6
                  data:
                  - col1: '99587000005130006'
                    col2: '99587000000190001'
                    col3: Imported product ksk
                    col4: '7'
                    col5: ''
                    col6: Hardware
                  - col1: '99587000005130026'
                    col2: '99587000000190001'
                    col3: Hello import
                    col4: goat
                    col5: ''
                    col6: Software
                  module: products
  securitySchemes:
    iam-oauth2-schema:
      $ref: ./Common.json#/components/securitySchemes/iam-oauth2-schema
x-entity: Helpcenter