VH3 AI

Read and write BigChange field service data and access VH3 AI intelligence features — jobs, contacts, invoices, reports, search, cases, and more.

Actions200

Account Report (VH3 AI) Actions
- Generate Account Report
Attachment (Web Services) Actions
- List Attachments for an Entity
- Retrieve an Attachment by ID
Briefing (VH3 AI) Actions
- Generate Briefing
Case (VH3 AI) Actions
- Add Case Item
- Add Comment
- Add Participant
- Assign Team
- Create Case
- Delete Case
- Get Case
- List Activity
- List Case Items
- List Cases
- List Cases for Item
- Remove Case Item
- Remove Participant
- Search Cases
- Transition Case
- Update Case
Connie (VH3 AI) Actions
- Chat
- Generate Summary
- Get Session Messages
- List Sessions
Contact (BigChange) Actions
- Create Contact
- Create Contact Group
- Edit Contact
- Get Contact
- Get Contact Group
- List Contact Groups
- List Contacts
- Stop Contact
- Unstop Contact
- Update Contact Group
Contact Feed (VH3 AI) Actions
- Get Enriched Contact
- List Contact Feed
Email (VH3 AI) Actions
- Batch Classify Emails
- Classify Email
- Ingest General Email
- Ingest Portal Email
- List Triage Categories
- List Triage Rules
Intelligence (VH3 AI) Actions
- Generate Profiles
- Get Profile
- List Profiles
Investigate (VH3 AI) Actions
- Run Investigation
Invoice (BigChange) Actions
- Cancel Invoice
- Create Invoice
- Create Invoice Line Item
- Delete Invoice Line Item
- Edit Invoice
- Get Invoice
- Get Invoice Line Item
- List Invoice Line Items
- List Invoices
- Mark Invoice Paid
- Mark Invoice Sent
Job (BigChange) Actions
- Cancel Job
- Create Job
- Create Job (Dynamic Fields)
- Create Job Stock
- Delete Job Constraint
- Edit Job
- Get Job
- Get Job by ID
- List Job Constraints
- List Job Status History
- List Job Stock
- List Jobs
- Schedule Job
- Set Job Result
- Start Job
Job Feed (VH3 AI) Actions
- Aggregate Jobs
- Get Enriched Job
- List Account Job Feed
- List Job Feed
Job Group (BigChange) Actions
- Create Job Group
- Edit Job Group
- Get Job Group
- List Job Group Status History
- List Job Groups
- Mark Job Group Complete
Job Type (BigChange) Actions
- Get Job Type
- List Job Types
Note (BigChange) Actions
- Create Note
- Create Progress Update
- Edit Note
- Get Note
- Get Note Type
- List Note Types
- List Notes
Person (BigChange) Actions
- Create Person
- Get Person
- List Consent History
- List Persons
Pulse (VH3 AI) Actions
- Get Pulse
Purchase Order (BigChange) Actions
- Create Purchase Order
- Create Purchase Order Line Item
- Delete Purchase Order Line Item
- Edit Purchase Order
- Edit Purchase Order Line Item
- Get Purchase Order
- Get Purchase Order Line Item
- Get Purchase Order Series
- List Purchase Order Line Items
- List Purchase Order Series
- List Purchase Orders
Quote (BigChange) Actions
- Create Quote
- Create Quote Line Item
- Delete Quote Line Item
- Edit Quote
- Get Quote
- Get Quote Line Item
- List Quote Line Items
- List Quotes
- Mark Quote Accepted
- Mark Quote Rejected
- Mark Quote Sent
Quote Document (VH3 AI) Actions
- Create Document
- Get Document
- Get Many Parts
- List Documents
- List Parts Catalog
- List Rate Cards
- List Revisions
- Update Commercial
- Update Revision Status
Quotient (VH3 AI) Actions
- Get Quote
- List Quotes
Reference Data (BigChange) Actions
- Get Department Code
- Get Nominal Code
- List Department Codes
- List Nominal Codes
Report (VH3 AI) Actions
- Generate Report
- List Report Sections
Report (Web Services) Actions
- Driver Infringement Events for a Date Range
- List Document Templates
- Vehicle Performance Data
Resource / Engineer (BigChange) Actions
- Create Resource
- Get Resource
- List Resources
Sales Opportunity (BigChange) Actions
- Create Sales Opportunity Line Item
- Delete Sales Opportunity Line Item
- Edit Sales Opportunity
- Get Sales Opportunity
- Get Sales Opportunity Line Item
- List Probabilities
- List Sales Opportunities
Search (VH3 AI) Actions
- Autocomplete
- Get Summary By Contact
- Search Intake
- Search Intake (Basic)
- Search Outcomes
- Search Outcomes (Enriched)
Sentinel (VH3 AI) Actions
- Get Latest Results
- List Sentinel Registry
Stock (BigChange) Actions
- Create Stock Details
- Create Stock Item
- Get Product Category
- Get Stock Details
- Get Stock Item
- Get Stock Supplier
- List Product Categories
- List Stock Details
- List Stock Items
- List Stock Suppliers
- Update Stock Details
- Update Stock Item
Team (VH3 AI) Actions
- Add Entity
- Add Member
- Create Team
- Get Team
- List Entities
- List Members
- List Teams
- Remove Entity
- Remove Member
- Search Teams
- Update Team
Tracking (Web Services) Actions
- Get Journey Data for a Date Range
- Get the Last Known Position of Assets
- Last Known Odometer Readings
- Last Known Position and Odometer
User (VH3 AI) Actions
- Delete User
- Invite User
- List Invites
- List User Teams
- List Users
Vehicle (BigChange) Actions
- Create Vehicle
- Get Vehicle
- List Vehicles
Weather (VH3 AI) Actions
- Get Forecast
- Get Historical
- Get Weather for Job
- Get Weather for Site
Worksheet (BigChange) Actions
- Get Worksheet
- Get Worksheet Questions
- List Worksheet Definitions
Worksheet Group (BigChange) Actions
- Get Worksheet Group
- List Worksheet Groups

Case (VH3 AI) → Delete Case

AI-generated

Summary

Archives a case in VH3 AI by sending it through the case transition endpoint with status set to archived. It does not hard-delete or restore the case.

Inputs

Case ID (required) — Numeric ID of the case to archive.
Actor ID — Optional Connect user ID when Actor Type is User. Omit or set to 0 to use the tenant API-key owner.
Actor Type — Who is archiving the case: Agent, System, or User. Defaults to User.

Output shape

A single item containing the API response.

The source defines the archive request but does not establish a more specific response shape.

VH3 AI

Actions200

Case (VH3 AI) → Delete Case

Summary

Inputs

Output shape

Links

Discussion

VH3 AIInstall

Actions200

Case (VH3 AI) → Delete Case

Summary

Inputs

Output shape

Links

Discussion

VH3 AI