Updates a Client

put

https://api.vcita.biz/platform/v1/clients/{client_id}

Overview

Update a Client Available for Staff, App, and Directory tokens.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

client_id

string

required

Client UID

Body Params

address

string

Address. Send null or "" to clear this field if force_nullifying is true.

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

First Name

force_nullifying

boolean

If true, allows nullable fields (address, mobile_phone) to be cleared by sending null or empty string. Must be boolean true or string "true".

last_name

string

Last Name

mobile_phone

string

Phone Number. Send null or "" to clear this field if force_nullifying is true.

phone

string

Phone Number

spam

boolean

Client marked as spam

staff_id

string

Staff ID

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

200Success