Create a Client

post

https://api.vcita.biz/platform/v1/clients

Overview

Creates a new client record for the business. If a client with the same email already exists, returns a 409 Conflict error.

Authentication

Available for Staff, App, and Directory Tokens.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

address

string

Address

custom_field1

string

Custom Field 1

custom_field2

string

Custom Field 2

custom_field3

string

Custom Field 3

string

Email Address. Must be a valid email format (e.g., [email protected])

first_name

string

required

First Name

last_name

string

Last Name

opt_in_transactional_sms

boolean

Whether the client opts in to receive transactional SMS messages.

phone

string

Phone Number

source_campaign

string

Source campaign

source_channel

string

Source channel

source_name

string

Source name

source_url

string

Source URL

staff_id

string

Staff ID. Reference to the staff member (see staff entity).

status

string

enum

Use a client status to categorize clients according to their relationship with your business. Valid values: lead, customer, loyal, inactive

Allowed:

tags

string

The tag system is based on customized labels that you create, so you can sort your data using personalized words, phrases or themes that are meaningful to you and your business

Response

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Success