Update Business Settings

put

https://api.vcita.biz/v2/settings/businesses/{business_uid}

Overview

Updates the business's own profile settings. Only the fields provided in the body are changed.

The address is a plain free-text string; it is geocoded server-side into structured_address, so a real, resolvable address must be sent (a made-up string may fail to geocode). structured_address is read-only and cannot be supplied as input — it is returned on the response once geocoding completes.

Available for Staff & Directory tokens — a Staff token of a staff member belonging to the business (with settings access), or a Directory token of the owning directory. Directory tokens MUST send the business in the X-On-Behalf-Of header (without it, a Directory token is rejected with 403). A client token or an unrelated staff is rejected with 401/403.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

business_uid

string

required

The business UID — the public identifier of the business (e.g., "fyclhomrzdspdyk6").

Body Params

name

string

length ≤ 100

Display name of the business (e.g., "Summit Peak Climate Solutions"). Max 100 characters; no HTML tags or newlines; must be non-empty and not a restricted/reserved word — otherwise rejected with 422.

address

string

The business's physical street address as free text. Geocoded server-side into the read-only structured_address; send a real, resolvable address (e.g., "233 S Wacker Dr, Chicago, IL 60606, USA"). HTML is stripped; no length limit is enforced on this endpoint.

billing_address

string

The billing address as free text, used on invoices and estimates (e.g., "233 S Wacker Dr, Chicago, IL 60606, USA"). HTML is stripped.

business_description

string

length ≤ 255

Short description of the business shown to clients (e.g., "Residential and commercial HVAC service.") Maximum 255 characters; longer values are rejected with 422.

phone_info

string

The business phone number (e.g., "+13125550142").

country_name

string

Country name for the business (e.g., "United States").

info_website

string

The business website URL (e.g., "https://summitpeakclimate.com").

display_country_code

boolean

Whether to show the country dialing code alongside the phone number (e.g., true, false).

locale

string

enum

The business locale / language (e.g., "en", "es"). Must be one of the supported locales; invalid values are rejected with 422.

sender_name

string

The name used as the sender on outgoing client communications (e.g., "Summit Peak Team").

use_sender_name

boolean

Whether to use sender_name on outgoing communications (e.g., true, false).

show_address

boolean

Whether the business address is shown on the client-facing site (e.g., true, false).

show_phone

boolean

Whether the business phone is shown on the client-facing site (e.g., true, false).

show_email

boolean

Whether the business email is shown on the client-facing site (e.g., true, false).

show_website

boolean

Whether the business website is shown on the client-facing site (e.g., true, false).

Headers

X-On-Behalf-Of

string

The business UID to act on behalf of. Required when authenticating with a Directory token; not needed for a Staff token (e.g., "fyclhomrzdspdyk6").

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

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

application/json

200The updated business settings object. When address changed, structured_address reflects the newly geocoded value.

401The staff lacks settings access for this business.

403The token is not authorized to act on this business — e.g. a Directory token sent without the X-On-Behalf-Of header, or a token that does not belong to the business or its owning directory.

422Validation failed for one or more fields.