Create Account API

API Reference: Create Business API

With Create Account API you can create a new account with your default values or copy an existing template to get specific settings and content to the new account (see "Templates" below).


Below are the minimum requirements for a successful call:

  • Authorization token (see details here)
  • User email
  • Business name

  • User Email and Business Name are the mandatory parameters to send in the API Body.

Example of Create Account API request only with the mandatory parameters:

curl --request POST \
     --url https://api.vcita.biz/platform/v1/businesses \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer {{AUTHORIZATION_TOKEN}}' \
     --header 'Content-Type: application/json' \
     --data @- <<EOF
{
    "admin_account": {
         "email": "[email protected]"
    },
    "business": {
         "name": "my business name"
    }
}

There are several additional parameters we can send when creating a new account. To name a few:

  • Business information - Address, Phone, Country, TimeZone etc
  • User information - Name, Email, Password, Phone, Language etc
  • Analytics data - Google, Mixpanel
  • External ID - Partner's ID or any other relevant external ID
  • Identities - Business verticals
  • Setup mode - If is_setup parameter is not sent in the API request, the account will automatically be set as "Setup Complete". If the parameter is sent as FALSE the account will be set as "In Setup" mode until you finish the onboarding process with the business owner and change it manually.
  • Templates -
    -- You can set the account to be a template account by sending is_template = TRUE
    -- Account can be copied from a template account by sending the relevant template_business_id (the business UID of the template)
  • Note and Tags - Ability to add Notes and Tags on the business for better management. You can see these values later in the Operator Portal or when getting the business data via API.

๐Ÿ“˜

Important

Business information (business) data is general information of the business (i.e. business address, business phone, business country, business timezone etc) while the User information (admin_account) data is the information of the business owner and its availability (i.e. owner name, owner email, password for login, owner phone etc)