API Reference
Start typing to search…

Import clients app

post
https://api.vcita.biz/business/clients/v1/apps//import

Overview

Import clients to an app. Creates client records based on the provided field mappings.

Authentication

Available for Staff, App, and Directory tokens.

Prerequisites

  1. The app specified by app_code_name must be assigned to the business
  2. The app must have app_type set to import_clients
  3. Use POST /v3/apps/app_assignments with assignment_mode: 'internal' to assign the app

Request Body

  • import_params: Configuration for the import process
  • fields_mapping: Maps client fields to their values
Language
Credentials
Bearer
JWT
Click Try It! to start a request and see the response here!