Jump to Content

Home Guides API Reference Changelog

API Reference

Home Guides API Reference Changelog

Platform API

Applications
Business
Staff
Wizard
Categories
- Get Categories [Alpha]get
Services
Clients
Matters
- Merge duplicate clients into a primary client.put
- List of clients that can be used as primary for merge.get
Client Packages
Conversations
- Get Conversations For A Clientget
- Get Conversationsget
Documents
- Get Documents For A Clientget
Estimates
Invoices
Payments
Directory
- Gets Directory's brandingget
Fields
Forms
- Get Formsget
- Updates a Formput
Appointments
LeadGen
- Creates a leadpost
Messages
- Create a Messagepost
Manage Numbers
Card
- Create sync cardpost
- Delete saved carddelete
Payment Checkout
- Send checkout update by webhookput
- Get Open Checkout For Specific url_keyget
Packages
Payment Settings
Payment Statuses
- Apply Couponput
- Validate Couponget
Bookings
Event Attendances
- Get Event Attendanceget
Event Instance
- Get Event Instanceget
Availability
- Get Multi Services availability [Alpha]get
- Get Service availability By ID [Alpha]get
Token Management
Webhooks

Scheduling related API

Bookings
ExternalCalendarItems
Weekly availability

client_api API

Forms

Payment related API (Business)

Card Requests
- Create Card Requestpost
- Get Card Requestget
card
- Update Cardput
Sales
Client Packages
- Show Client Package Info [Alpha]get
- Update client package [Alpha]put
Deposits
Estimates
Invoices
Packages
- Reorder packages [Alpha]put
Payment Requests
Payments
Payouts
Product Orders
Products
Refunds
- Create Refundpost
Scheduled Payment Rule
Bulk Taxes
Taxes
Transactions
Coupons
- Get all couponsget
Payments Widgets
- Payments widgetget

Payment related API (Clients)

Apps
- Get External Connected Payment Applicationget
Cards
Carts
- Create Cartpost
- Show Cartget
Client Packages
- List of Client Packagesget
Deposits
- Show Deposits Listget
- Show Depositget
Invoices
- Show Invoices Listget
Packages
- List Packages Info [Alpha]get
- Show Package Info [Alpha]get
Payment Requests
- Get Payment Requests Listget
- Get Checkout Sessionget
Payments
- Show Payments Listget
Product Orders
- Show Product Orders Listget

Client related API

Matters
Client Settings
- Retrieve Client Settingsget
- Update Client Settingsput

Business Messaging API

Messaging Channels
- Create a mesaging channelpost
Typing Indicator
- Notify Typing Indicatorpost
Activity Message
- Send activity message apipost
- Send activity message apipost

communicationgw

channels
messages
- /messagespost
- /messages/{messageUid}put
oauth
- /oauthget
sessions

Accounts related API

Business Attributes
- Gets business attributesget
Business Branding
- Gets the branding of the businessget
Business
Business account usage
- Business account usage in the last 3 monthsget

Staff related API

Staff activity
- Daily Staff Sign-insget
Staff
- Updates a staff's propertiesput

Oauth API

Token Management
- Exchanges a OAuth Code for an Access Tokenpost
OpenID
- Get authenticated user infoget

Webhooks responses

Getting Started
App
- App Installed
- App Uninstalled
Appointment
Business Account
Client
- Client updated
- Client Created
Conversation Read
Conversation item Created
Deposit Created
Document Sent
Estimate
Event Registration
- Event registration Created
- Event registration Updated
Invoice
- Invoice issued
- Invoice Updated
Payment
Message
- Message Business sent message
- Message Client sent message
Messaging Channel Status
Matter
- Matter Delete
- Matter Recover
Payment Gateway Settings
- Payment Gateway Settings Connected
- Payment Gateway Settings Disconnected
Review Submitted
Service Updated
Staff
Subscription
- Purchasable Subscription Created (deprecated)
- Purchasable Subscription Updated (deprecated)
Tag
- Tag Add
- Tag Delete
Bulk Client Import

Partners API

Account Management
Injection Leads From Any Form
- Lead Injectionpost
Reporting
Single Sign On
- SSO APIget
- Emails & SMS

License

Subscription

Powered by

/messages/{messageUid}

put https://api.vcita.biz/business/communication/messages/{messageUid}

Update message status.

Language

Click Try It! to start a request and see the response here!