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.

opt_in

boolean

Marketing email opt-in status. Accepts boolean values (true / false) or string values ("1" / "0"). When set to true (or "1"), the client is opted in to receive marketing emails; when set to false (or "0"), the client is opted out. This is distinct from opt_in_transactional_sms, which controls transactional SMS consent.

phone

string

Phone Number

source_name

string

Source name. Updates the client's source label (e.g., "website", "client_portal", "contact_form"). The new value is reflected in the source field on subsequent GET responses. Note: unlike POST /platform/v1/clients, this does NOT create or update the underlying source record, so existing source_url, channel, and campaign values remain unchanged.

source_url

string

Source URL. Persists the URL on the client record but, unlike POST /platform/v1/clients, does NOT update the underlying source record. As a result, the value will not be reflected in the source_url field returned by subsequent GET responses (which is read from the source record). To change the visible source_url, channel, or campaign of an existing client, the source record itself must be updated through other means.

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:

200Success