API Reference

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
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

App code name

Body Params
fields_mapping
object
required

Maps client fields to their values. At minimum, provide email or phone for contact identification.

import_params
object
required

Configuration for the import process

Responses

Updated 3 months ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago