VH3 AI icon

VH3 AI

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

Actions200

Team (VH3 AI) → Add Entity

AI-generated

Summary

Adds an existing record to a team by submitting its entity type and ID, with optional actor, context, label, and metadata details.

Inputs

  • Team ID (required) — Numeric ID of the team to update.
  • Entity Type (required) — Type of record to link: Case, Customer, Document, Engineer, Job, Job Group, Note, or Site.
  • Entity ID (required) — ID of the record to add to the team.
  • Actor ID — Optional user ID of the actor performing the link.
  • Actor Type — Optional actor category: Agent, System, or User; defaults to User.
  • Context — Optional reason the entity is being added.
  • Label — Optional human-readable display name.
  • Metadata (JSON) — Optional type-specific extra data as JSON; defaults to an empty object.

Output shape

a single record

The supplied source excerpt does not show the operation's request or response handling, so the exact returned fields are not specified.

Links

Discussion