vCita Client Settings API
The Client Settings API from vCita — 2 operation(s) for client settings.
The Client Settings API from vCita — 2 operation(s) for client settings.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/vcita:vcita-client-settings-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Clients Client Settings API
description: Unified OpenAPI specification for clients domain
version: '3.0'
x-generated:
sourceFiles:
- activity_sources.json
- legacy_v1_platform_clients.json
- search.json
- legacy_v1_clients.json
- manage_clients.json
- client_settings.json
- notes.json
- clients_payments.json
- client_messaging.json
- crm_views.json
pathNormalizations:
- file: legacy_v1_platform_clients.json
basePath: /platform/v1
transformations:
- original: /fields
normalized: /platform/v1/fields
basePath: /platform/v1
- original: /fields/{field_id}
normalized: /platform/v1/fields/{field_id}
basePath: /platform/v1
- file: legacy_v1_clients.json
basePath: /platform/v1
transformations:
- original: /clients
normalized: /platform/v1/clients
basePath: /platform/v1
- original: /clients/bulk
normalized: /platform/v1/clients/bulk
basePath: /platform/v1
- original: /clients/merges/merge_clients
normalized: /platform/v1/clients/merges/merge_clients
basePath: /platform/v1
- original: /clients/merges/possible_merge_master
normalized: /platform/v1/clients/merges/possible_merge_master
basePath: /platform/v1
- original: /clients/payment/client_packages/update_usage
normalized: /platform/v1/clients/payment/client_packages/update_usage
basePath: /platform/v1
- original: /clients/payment/client_packages/validate
normalized: /platform/v1/clients/payment/client_packages/validate
basePath: /platform/v1
- original: /clients/{client_id}
normalized: /platform/v1/clients/{client_id}
basePath: /platform/v1
- original: /clients/{client_id}/estimates
normalized: /platform/v1/clients/{client_id}/estimates
basePath: /platform/v1
- original: /clients/{client_id}/invoices
normalized: /platform/v1/clients/{client_id}/invoices
basePath: /platform/v1
- original: /clients/{client_id}/payments
normalized: /platform/v1/clients/{client_id}/payments
basePath: /platform/v1
- file: manage_clients.json
basePath: /business/clients
transformations:
- original: /v1/apps/{app_code_name}/import
normalized: /business/clients/v1/apps/{app_code_name}/import
basePath: /business/clients
- original: /v1/contacts/{client_uid}/matters
normalized: /business/clients/v1/contacts/{client_uid}/matters
basePath: /business/clients
- original: /v1/matters
normalized: /business/clients/v1/matters
basePath: /business/clients
- original: /v1/matters/{matter_uid}/collaborators
normalized: /business/clients/v1/matters/{matter_uid}/collaborators
basePath: /business/clients
- original: /v1/matters/{matter_uid}/collaborators/{staff_uid}
normalized: /business/clients/v1/matters/{matter_uid}/collaborators/{staff_uid}
basePath: /business/clients
- original: /v1/matters/{matter_uid}/nest
normalized: /business/clients/v1/matters/{matter_uid}/nest
basePath: /business/clients
- original: /v1/matters/{matter_uid}/notes
normalized: /business/clients/v1/matters/{matter_uid}/notes
basePath: /business/clients
- original: /v1/matters/{matter_uid}/notes/{note_uid}
normalized: /business/clients/v1/matters/{matter_uid}/notes/{note_uid}
basePath: /business/clients
- original: /v1/matters/{matter_uid}/reassign
normalized: /business/clients/v1/matters/{matter_uid}/reassign
basePath: /business/clients
- original: /v1/tags
normalized: /business/clients/v1/tags
basePath: /business/clients
- original: /v1/matters/{matter_uid}/tags
normalized: /business/clients/v1/matters/{matter_uid}/tags
basePath: /business/clients
- original: /v1/matters/{uid}
normalized: /business/clients/v1/matters/{uid}
basePath: /business/clients
- original: /v1/settings
normalized: /business/clients/v1/settings
basePath: /business/clients
- file: clients_payments.json
basePath: /client/payments
transformations:
- original: /v1/apps/primary_provider_connected_application
normalized: /client/payments/v1/apps/primary_provider_connected_application
basePath: /client/payments
- original: /v1/cards
normalized: /client/payments/v1/cards
basePath: /client/payments
- original: /v1/cards/get_new_card
normalized: /client/payments/v1/cards/get_new_card
basePath: /client/payments
- original: /v1/cards/save_card_session
normalized: /client/payments/v1/cards/save_card_session
basePath: /client/payments
- original: /v1/carts
normalized: /client/payments/v1/carts
basePath: /client/payments
- original: /v1/carts/{cart_uid}
normalized: /client/payments/v1/carts/{cart_uid}
basePath: /client/payments
- original: /v1/client_packages
normalized: /client/payments/v1/client_packages
basePath: /client/payments
- original: /v1/deposits
normalized: /client/payments/v1/deposits
basePath: /client/payments
- original: /v1/deposits/{deposit_uid}
normalized: /client/payments/v1/deposits/{deposit_uid}
basePath: /client/payments
- original: /v1/invoices
normalized: /client/payments/v1/invoices
basePath: /client/payments
- original: /v1/packages
normalized: /client/payments/v1/packages
basePath: /client/payments
- original: /v1/packages/{package_id}
normalized: /client/payments/v1/packages/{package_id}
basePath: /client/payments
- original: /v1/payment_requests
normalized: /client/payments/v1/payment_requests
basePath: /client/payments
- original: /v1/payment_requests/{payment_request_uid}/checkout
normalized: /client/payments/v1/payment_requests/{payment_request_uid}/checkout
basePath: /client/payments
- original: /v1/payments
normalized: /client/payments/v1/payments
basePath: /client/payments
- original: /v1/product_orders
normalized: /client/payments/v1/product_orders
basePath: /client/payments
- file: client_messaging.json
basePath: /client/messaging
transformations:
- original: /v1/messages
normalized: /client/messaging/v1/messages
basePath: /client/messaging
- file: crm_views.json
basePath: /business/search/v1
transformations:
- original: /views
normalized: /business/search/v1/views
basePath: /business/search/v1
- original: /views/{uid}
normalized: /business/search/v1/views/{uid}
basePath: /business/search/v1
- original: /views/bulk
normalized: /business/search/v1/views/bulk
basePath: /business/search/v1
- original: /views_columns
normalized: /business/search/v1/views_columns
basePath: /business/search/v1
- original: /view_filters
normalized: /business/search/v1/view_filters
basePath: /business/search/v1
pathConflicts: []
componentConflicts:
- type: schema
name: ErrorResponse
resolution: Renamed to ErrorResponse_search
files:
- merged
- search.json
- type: schema
name: ErrorResponse
resolution: Renamed to ErrorResponse_notes
files:
- merged
- notes.json
totalPaths: 54
totalComponents: 27
servers:
- url: https://api.vcita.biz
description: Unified API Gateway server
tags:
- name: Client Settings
paths:
/v3/clients/client_settings/bulk:
put:
summary: Bulk Update Client Settings
description: '## Overview
Bulk update client settings for multiple clients in a single operation. Supports partial success - individual clients can fail while others succeed.
## Currently Supported Field
This endpoint currently supports updating **only** the `opt_out_transactional_sms` field. Any request containing other fields will be rejected with a validation error.
## Field Requirements
- `opt_out_transactional_sms` must be an explicit boolean value (`true` or `false`)
- `null` values are **not allowed**
- Missing the field will cause validation failure
## Limits
- Maximum 5000 clients per request
- Duplicate client UIDs are not allowed
- Additional rate limits apply per business
## Authentication
**Available for Staff Tokens only.**
Client tokens should use the single update endpoint `/v3/clients/client_settings/{client_uid}` instead.
## Response Behavior
- Returns HTTP 200 with an array of results (one per client)
- Each result includes a `success` boolean and either `data` (on success) or `errors` (on failure)
- Individual client failures (e.g., not found) do not prevent other clients from being updated'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BulkUpdateRequest'
example:
client_settings:
- client_uid: cmf62p00w2ns3chq
opt_out_transactional_sms: true
- client_uid: cmf62p10x3ot4dir
opt_out_transactional_sms: false
responses:
'200':
description: Bulk update completed (may contain partial failures)
content:
application/json:
schema:
allOf:
- type: object
properties:
success:
type: boolean
description: Indicates whether the API request was successful (true) or failed (false).
data:
type: object
description: 'The response payload. Present on successful responses (success: true).'
error:
type: string
description: Error message for simple error responses. Used in some legacy endpoints.
errors:
type: array
description: 'Array of error objects for detailed error responses. Present on error responses (success: false).'
items:
type: object
properties:
code:
type: string
description: Machine-readable error code (e.g., 'already_exists', 'invalid', 'not_found').
message:
type: string
description: Human-readable error message.
field:
type: string
description: The field that caused the error (for validation errors).
required:
- code
- message
required:
- success
description: Generic wrapper object for API responses. Success responses contain 'data', while error responses contain 'errors' array or 'error' string.
- properties:
data:
type: object
properties:
client_settings:
type: array
description: Array of results for each client (all items have success indicator)
items:
type: object
required:
- success
properties:
success:
type: boolean
description: Indicates if the operation succeeded for this client
data:
type: object
properties:
client_uid:
type: string
readOnly: true
description: The unique identifier (UID) of the client.
client_id:
type:
- integer
- 'null'
readOnly: true
description: The numeric client ID (internal identifier).
opt_out_transactional_sms:
type: boolean
description: The opt out status of the client for transactional SMS messages.
preferred_language:
type: string
description: The client's preferred language code (e.g., "en", "he", "es"). Can be null if not set.
effective_language:
type: string
readOnly: true
description: The effective language used for the client, taking into account business defaults if preferred_language is not set.
created_at:
type: string
format: date-time
readOnly: true
description: The date and time when the client settings were created, in ISO 8601 format.
updated_at:
type: string
format: date-time
readOnly: true
description: The date and time when the client settings were last updated, in ISO 8601 format.
required:
- client_uid
- created_at
- updated_at
example:
client_uid: d290f1ee-6c54-4b01-90e6-d701748f0851
client_id: 12345678
opt_out_transactional_sms: true
preferred_language: en
effective_language: en
created_at: '2021-07-20T14:00:00Z'
updated_at: '2021-07-20T14:00:00Z'
description: Client settings data (only present when success is true)
errors:
type: array
description: Error details (only present when success is false)
items:
type: object
properties:
code:
type: string
example: not_found
message:
type: string
example: Client not found
example:
success: true
data:
client_settings:
- success: true
data:
client_uid: cmf62p00w2ns3chq
opt_out_transactional_sms: true
preferred_language: null
effective_language: en
created_at: '2026-04-29T13:56:58.123Z'
updated_at: '2026-04-29T13:56:58.123Z'
- success: false
errors:
- code: not_found
message: Client not found
- success: true
data:
client_uid: cmf62p10x3ot4dir
opt_out_transactional_sms: false
preferred_language: es
effective_language: es
created_at: '2026-04-29T13:56:58.123Z'
updated_at: '2026-04-29T13:56:58.123Z'
'401':
description: Unauthorized - only staff tokens allowed
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
errors:
type: array
items:
type: object
properties:
code:
type: string
example: unauthorized
message:
type: string
example: Only staff tokens are allowed for bulk operations
'422':
description: Unprocessable Entity - Validation error (invalid fields, missing required field, duplicates, or exceeds max batch size)
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
errors:
type: array
items:
type: object
properties:
code:
type: string
example: invalid
field:
type: string
example: opt_out_transactional_sms
message:
type: string
example: Only 'client_uid' and 'opt_out_transactional_sms' fields are allowed
tags:
- Client Settings
security:
- Bearer: []
operationId: putV3ClientsClientSettingsBulk
x-operation-id-source: derived
/v3/clients/client_settings/{client_uid}:
get:
summary: Retrieve Client Settings
description: '## Overview
Get the client settings for a specific client.
## Authentication
**Available for Staff and Client Tokens.**'
parameters:
- name: client_uid
required: true
in: path
description: Unique identifier of the Client
schema:
type: string
example: cmf62p00w2ns3chq
responses:
'200':
description: ''
content:
application/json:
schema:
allOf:
- type: object
properties:
success:
type: boolean
description: Indicates whether the API request was successful (true) or failed (false).
data:
type: object
description: 'The response payload. Present on successful responses (success: true).'
error:
type: string
description: Error message for simple error responses. Used in some legacy endpoints.
errors:
type: array
description: 'Array of error objects for detailed error responses. Present on error responses (success: false).'
items:
type: object
properties:
code:
type: string
description: Machine-readable error code (e.g., 'already_exists', 'invalid', 'not_found').
message:
type: string
description: Human-readable error message.
field:
type: string
description: The field that caused the error (for validation errors).
required:
- code
- message
required:
- success
description: Generic wrapper object for API responses. Success responses contain 'data', while error responses contain 'errors' array or 'error' string.
- properties:
data:
type: object
properties:
client_uid:
type: string
readOnly: true
description: The unique identifier (UID) of the client.
client_id:
type:
- integer
- 'null'
readOnly: true
description: The numeric client ID (internal identifier).
opt_out_transactional_sms:
type: boolean
description: The opt out status of the client for transactional SMS messages.
preferred_language:
type: string
description: The client's preferred language code (e.g., "en", "he", "es"). Can be null if not set.
effective_language:
type: string
readOnly: true
description: The effective language used for the client, taking into account business defaults if preferred_language is not set.
created_at:
type: string
format: date-time
readOnly: true
description: The date and time when the client settings were created, in ISO 8601 format.
updated_at:
type: string
format: date-time
readOnly: true
description: The date and time when the client settings were last updated, in ISO 8601 format.
required:
- client_uid
- created_at
- updated_at
example:
client_uid: d290f1ee-6c54-4b01-90e6-d701748f0851
client_id: 12345678
opt_out_transactional_sms: true
preferred_language: en
effective_language: en
created_at: '2021-07-20T14:00:00Z'
updated_at: '2021-07-20T14:00:00Z'
description: Client-level settings such as communication preferences and opt-outs.
tags:
- Client Settings
security:
- Bearer: []
operationId: getV3ClientsClientSettingsByClientUid
x-operation-id-source: derived
put:
summary: Update Client Settings
description: '## Overview
Update the client settings for a specific client - Update the client settings for a specific client - Available for **Staff and Client Tokens**.'
parameters:
- name: client_uid
required: true
in: path
description: Unique identifier of the Client
schema:
type: string
example: cmf62p00w2ns3chq
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
opt_out_transactional_sms:
type: boolean
description: Opt out from transactional SMS
required:
- client_uid
responses:
'200':
description: ''
content:
application/json:
schema:
allOf:
- type: object
properties:
success:
type: boolean
description: Indicates whether the API request was successful (true) or failed (false).
data:
type: object
description: 'The response payload. Present on successful responses (success: true).'
error:
type: string
description: Error message for simple error responses. Used in some legacy endpoints.
errors:
type: array
description: 'Array of error objects for detailed error responses. Present on error responses (success: false).'
items:
type: object
properties:
code:
type: string
description: Machine-readable error code (e.g., 'already_exists', 'invalid', 'not_found').
message:
type: string
description: Human-readable error message.
field:
type: string
description: The field that caused the error (for validation errors).
required:
- code
- message
required:
- success
description: Generic wrapper object for API responses. Success responses contain 'data', while error responses contain 'errors' array or 'error' string.
- properties:
data:
type: object
properties:
client_uid:
type: string
readOnly: true
description: The unique identifier (UID) of the client.
client_id:
type:
- integer
- 'null'
readOnly: true
description: The numeric client ID (internal identifier).
opt_out_transactional_sms:
type: boolean
description: The opt out status of the client for transactional SMS messages.
preferred_language:
type: string
description: The client's preferred language code (e.g., "en", "he", "es"). Can be null if not set.
effective_language:
type: string
readOnly: true
description: The effective language used for the client, taking into account business defaults if preferred_language is not set.
created_at:
type: string
format: date-time
readOnly: true
description: The date and time when the client settings were created, in ISO 8601 format.
updated_at:
type: string
format: date-time
readOnly: true
description: The date and time when the client settings were last updated, in ISO 8601 format.
required:
- client_uid
- created_at
- updated_at
example:
client_uid: d290f1ee-6c54-4b01-90e6-d701748f0851
client_id: 12345678
opt_out_transactional_sms: true
preferred_language: en
effective_language: en
created_at: '2021-07-20T14:00:00Z'
updated_at: '2021-07-20T14:00:00Z'
description: Client-level settings such as communication preferences and opt-outs.
tags:
- Client Settings
security:
- Bearer: []
operationId: putV3ClientsClientSettingsByClientUid
x-operation-id-source: derived
components:
schemas:
BulkUpdateRequest:
type: object
properties:
client_settings:
type: array
description: Array of client settings to update (max 5000)
maxItems: 5000
items:
type: object
required:
- client_uid
- opt_out_transactional_sms
properties:
client_uid:
type: string
description: Unique identifier of the client
example: cmf62p00w2ns3chq
opt_out_transactional_sms:
type: boolean
description: Opt out from transactional SMS. Must be an explicit boolean value (true or false). Null values are not allowed.
required:
- client_settings
securitySchemes:
ActivitySources:
type: http
scheme: bearer
description: 'Provide a valid bearer token in the Authorization header. Example: ''Authorization: Bearer {token}'''
Bearer:
type: http
scheme: bearer
bearerFormat: JWT
description: 'Provide a valid bearer token in the Authorization header. Example: ''Authorization: Bearer {app_token}'''
Notes:
type: http
scheme: bearer
bearerFormat: JWT
description: 'Provide a valid bearer token in the Authorization header. Example: ''Authorization: Bearer {token}'''
ClientMessaging:
type: http
scheme: bearer
bearerFormat: JWT
description: 'Provide a valid client bearer token in the Authorization header. Example: ''Authorization: Bearer {client_token}'''
x-provenance:
method: searched
source: https://developers.intandem.tech:443/reference
harvested: '2026-11-15'
tool: harvest-readme-openapi.py
note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
assembled_from:
- https://developers.intandem.tech/reference/bulkupdateclients.md
- https://developers.intandem.tech/reference/createactivitysource.md
- https://developers.intandem.tech/reference/delete_business-clients-v1-matters-matter-uid-collaborators-staff-uid.md
- https://developers.intandem.tech/reference/delete_business-clients-v1-matters-matter-uid-notes-note-uid.md
- https://developers.intandem.tech/reference/delete_business-clients-v1-matters-matter-uid-tags.md
- https://developers.intandem.tech/reference/delete_business-clients-v1-tags.md
- https://developers.intandem.tech/reference/delete_business-search-v1-views-uid.md
- https://developers.intandem.tech/reference/delete_platform-v1-clients-client-id.md
- https://developers.intandem.tech/reference/delete_platform-v1-fields-field-id.md
- https://developers.intandem.tech/reference/delete_v3-clients-client-notes-uid.md
- https://developers.intandem.tech/reference/get_business-clients-v1-contacts-client-uid-matters.md
- https://developers.intandem.tech/reference/get_business-clients-v1-matters-matter-uid-collaborators.md
- https://developers.intandem.tech/reference/get_business-clients-v1-matters-matter-uid-notes-note-uid.md
- https://developers.intandem.tech/reference/get_business-clients-v1-matters-matter-uid-notes.md
- https://developers.intandem.tech/reference/get_business-clients-v1-matters-matter-uid-tags.md
- https://developers.intandem.tech/reference/get_business-clients-v1-matters-uid.md
- https://developers.intandem.tech/reference/get_business-clients-v1-matters.md
- https://developers.intandem.tech/reference/get_business-clients-v1-settings.md
- https://developers.intandem.tech/reference/get_business-search-v1-view-filters.md
- https://developers.intandem.tech/reference/get_business-search-v1-views-columns.md
# --- truncated at 32 KB (44 KB total) ---
# Full source: https://artifacts.apis.io/vcita/openapi/vcita-client-settings-api-openapi.yml