Documentation Index
Fetch the complete documentation index at: https://docs.plura.ai/llms.txt
Use this file to discover all available pages before exploring further.
Overview
Field-service operations, estimates, and work orders in ServiceBridge. Call actions with automationType, action, and params from any workflow node that supports automations.
Authentication
- ServiceBridge Login action returns a session key used by subsequent requests.
Available Actions
Click any action to jump to its example payload.
Accounting
Activity-Notes
Assets
Authentication
Branches
Companies
Contacts
Custom-Fields
Customers
Estimates
Inventory
Invoices
Jobs
Leads
Locations
Marketing
Payments
Personnel
Sales
Service-Agreements
Service-Plans
Statistics
Tasks
Taxes
Teams
Terms
Users
Work-Orders
Examples
Example 1: ServiceBridge - Login to ServiceBridge
Authenticate and obtain a session key
{
"automationType": "servicebridge",
"nodeId": "servicebridge-login",
"nodeParams": {
"action": "login",
"params": {
"userId": "your-api-user-id",
"password": "your-password"
}
}
}
Example 2: ServiceBridge - Logout from ServiceBridge
Invalidate the current session
{
"automationType": "servicebridge",
"nodeId": "servicebridge-logout",
"nodeParams": {
"action": "logout",
"params": {}
}
}
Example 3: ServiceBridge - List Customers
Get a paginated list of customers
{
"automationType": "servicebridge",
"nodeId": "servicebridge-list-customers",
"nodeParams": {
"action": "list_customers",
"params": {
"page": 1,
"pageSize": 50
}
}
}
Example 4: ServiceBridge - Get Customer by ID
Retrieve a specific customer
{
"automationType": "servicebridge",
"nodeId": "servicebridge-get-customer",
"nodeParams": {
"action": "get_customer",
"params": {
"customerId": "123"
}
}
}
Example 5: ServiceBridge - Create Customer
Create a new customer (lead)
{
"automationType": "servicebridge",
"nodeId": "servicebridge-create-customer",
"nodeParams": {
"action": "create_customer",
"params": {
"input": {
"DisplayName": "John Doe",
"CustomerType": "Residential",
"DefaultServiceLocation": {
"LocationName": "Home",
"PrimaryContact": {
"FirstName": "John",
"LastName": "Doe",
"PhoneNumber": "555-123-4567",
"Email": "john@example.com"
},
"AddressLine1": "123 Main St",
"City": "Columbus",
"State": "OH",
"PostalCode": "43215"
}
}
}
}
}
Example 6: ServiceBridge - Update Customer
Update an existing customer (sparse update)
{
"automationType": "servicebridge",
"nodeId": "servicebridge-update-customer",
"nodeParams": {
"action": "update_customer",
"params": {
"customerId": "123",
"input": {
"SparseUpdate": true,
"Version": 1,
"DisplayName": "John Doe Updated",
"UpdateDisplayName": true
}
}
}
}
Example 7: ServiceBridge - Delete Customer
Delete a customer
{
"automationType": "servicebridge",
"nodeId": "servicebridge-delete-customer",
"nodeParams": {
"action": "delete_customer",
"params": {
"customerId": "123"
}
}
}
Example 8: ServiceBridge - Activate Customer
Mark a customer as active
{
"automationType": "servicebridge",
"nodeId": "servicebridge-make-customer-active",
"nodeParams": {
"action": "make_customer_active",
"params": {
"customerId": "123"
}
}
}
Example 9: ServiceBridge - Get Customer Bank Accounts
Get saved bank accounts for a customer
{
"automationType": "servicebridge",
"nodeId": "servicebridge-get-customer-payment-bank-accounts",
"nodeParams": {
"action": "get_customer_payment_bank_accounts",
"params": {
"customerId": "123"
}
}
}
Example 10: ServiceBridge - Get Customer Payment Cards
Get saved payment cards for a customer
{
"automationType": "servicebridge",
"nodeId": "servicebridge-get-customer-payment-cards",
"nodeParams": {
"action": "get_customer_payment_cards",
"params": {
"customerId": "123"
}
}
}
Example 11: ServiceBridge - Create Customer Category
Create a new customer category
{
"automationType": "servicebridge",
"nodeId": "servicebridge-create-customer-category",
"nodeParams": {
"action": "create_customer_category",
"params": {
"input": {
"Name": "VIP Customers"
}
}
}
}
Get contacts for a customer
{
"automationType": "servicebridge",
"nodeId": "servicebridge-list-contacts",
"nodeParams": {
"action": "list_contacts",
"params": {
"customerId": "123",
"page": 1,
"pageSize": 50
}
}
}
Get a specific contact
{
"automationType": "servicebridge",
"nodeId": "servicebridge-get-contact",
"nodeParams": {
"action": "get_contact",
"params": {
"contactId": "456"
}
}
}
Create a new contact for a customer
{
"automationType": "servicebridge",
"nodeId": "servicebridge-create-contact",
"nodeParams": {
"action": "create_contact",
"params": {
"customerId": "123",
"input": {
"FirstName": "Jane",
"LastName": "Smith",
"Email": "jane@example.com",
"PhoneNumber": "555-987-6543"
}
}
}
}
Update an existing contact
{
"automationType": "servicebridge",
"nodeId": "servicebridge-update-contact",
"nodeParams": {
"action": "update_contact",
"params": {
"contactId": "456",
"input": {
"SparseUpdate": true,
"Version": 1,
"Email": "newemail@example.com",
"UpdateEmail": true
}
}
}
}
Delete a contact
{
"automationType": "servicebridge",
"nodeId": "servicebridge-delete-contact",
"nodeParams": {
"action": "delete_contact",
"params": {
"contactId": "456"
}
}
}
Example 17: ServiceBridge - List Locations
Get a paginated list of service locations
{
"automationType": "servicebridge",
"nodeId": "servicebridge-list-locations",
"nodeParams": {
"action": "list_locations",
"params": {
"page": 1,
"pageSize": 50
}
}
}
Example 18: ServiceBridge - Get Location
Get a specific location
{
"automationType": "servicebridge",
"nodeId": "servicebridge-get-location",
"nodeParams": {
"action": "get_location",
"params": {
"locationId": "789"
}
}
}
Get contacts at a location
{
"automationType": "servicebridge",
"nodeId": "servicebridge-list-location-contacts",
"nodeParams": {
"action": "list_location_contacts",
"params": {
"locationId": "789",
"page": 1,
"pageSize": 50
}
}
}
Update a contact at a location
{
"automationType": "servicebridge",
"nodeId": "servicebridge-update-location-contact",
"nodeParams": {
"action": "update_location_contact",
"params": {
"locationId": "789",
"contactId": "456",
"input": {}
}
}
}
Remove a contact from a location
{
"automationType": "servicebridge",
"nodeId": "servicebridge-delete-location-contact",
"nodeParams": {
"action": "delete_location_contact",
"params": {
"locationId": "789",
"contactId": "456"
}
}
}
Example 22: ServiceBridge - List Estimates
Get a paginated list of estimates
{
"automationType": "servicebridge",
"nodeId": "servicebridge-list-estimates",
"nodeParams": {
"action": "list_estimates",
"params": {
"page": 1,
"pageSize": 50
}
}
}
Example 23: ServiceBridge - Get Estimate
Get a specific estimate
{
"automationType": "servicebridge",
"nodeId": "servicebridge-get-estimate",
"nodeParams": {
"action": "get_estimate",
"params": {
"estimateId": "100"
}
}
}
Example 24: ServiceBridge - Create Estimate
Create a new estimate (free inspection)
{
"automationType": "servicebridge",
"nodeId": "servicebridge-create-estimate",
"nodeParams": {
"action": "create_estimate",
"params": {
"input": {
"Customer": {
"Id": 123
},
"Description": "Free Home Insulation Inspection",
"ScheduledStartDate": "2026-01-25T10:00:00Z",
"Duration": 60
}
}
}
}
Example 25: ServiceBridge - Update Estimate
Update an existing estimate
{
"automationType": "servicebridge",
"nodeId": "servicebridge-update-estimate",
"nodeParams": {
"action": "update_estimate",
"params": {
"estimateId": "100",
"input": {
"SparseUpdate": true,
"Version": 1,
"Status": "Assigned",
"UpdateStatus": true
}
}
}
}
Example 26: ServiceBridge - Delete Estimate
Delete an estimate
{
"automationType": "servicebridge",
"nodeId": "servicebridge-delete-estimate",
"nodeParams": {
"action": "delete_estimate",
"params": {
"estimateId": "100"
}
}
}
Example 27: ServiceBridge - Duplicate Estimate
Create a copy of an estimate
{
"automationType": "servicebridge",
"nodeId": "servicebridge-duplicate-estimate",
"nodeParams": {
"action": "duplicate_estimate",
"params": {
"estimateId": "100"
}
}
}
Example 28: ServiceBridge - Win Estimate
Mark estimate as won
{
"automationType": "servicebridge",
"nodeId": "servicebridge-win-estimate",
"nodeParams": {
"action": "win_estimate",
"params": {
"estimateId": "100"
}
}
}
Example 29: ServiceBridge - Lose Estimate
Mark estimate as lost
{
"automationType": "servicebridge",
"nodeId": "servicebridge-lose-estimate",
"nodeParams": {
"action": "lose_estimate",
"params": {
"estimateId": "100"
}
}
}
Example 30: ServiceBridge - Reopen Estimate
Reopen a closed estimate
{
"automationType": "servicebridge",
"nodeId": "servicebridge-reopen-estimate",
"nodeParams": {
"action": "reopen_estimate",
"params": {
"estimateId": "100"
}
}
}
Example 31: ServiceBridge - Get Estimate Documents
List documents for an estimate
{
"automationType": "servicebridge",
"nodeId": "servicebridge-get-estimate-documents",
"nodeParams": {
"action": "get_estimate_documents",
"params": {
"estimateId": "100"
}
}
}
Example 32: ServiceBridge - Get Estimate Document
Get a specific document
{
"automationType": "servicebridge",
"nodeId": "servicebridge-get-estimate-document",
"nodeParams": {
"action": "get_estimate_document",
"params": {
"estimateId": "100",
"documentId": "200"
}
}
}
Example 33: ServiceBridge - Get Estimate Photos
List photos for an estimate
{
"automationType": "servicebridge",
"nodeId": "servicebridge-get-estimate-photos",
"nodeParams": {
"action": "get_estimate_photos",
"params": {
"estimateId": "100"
}
}
}
Example 34: ServiceBridge - List Work Orders
Get a paginated list of work orders
{
"automationType": "servicebridge",
"nodeId": "servicebridge-list-work-orders",
"nodeParams": {
"action": "list_work_orders",
"params": {
"page": 1,
"pageSize": 50
}
}
}
Example 35: ServiceBridge - Get Work Order
Get a specific work order
{
"automationType": "servicebridge",
"nodeId": "servicebridge-get-work-order",
"nodeParams": {
"action": "get_work_order",
"params": {
"workOrderId": "300"
}
}
}
Example 36: ServiceBridge - Create Work Order
Create a new work order (installation job)
{
"automationType": "servicebridge",
"nodeId": "servicebridge-create-work-order",
"nodeParams": {
"action": "create_work_order",
"params": {
"input": {
"Customer": {
"Id": 123
},
"Description": "Attic Insulation Installation",
"ScheduledStartDate": "2026-02-01T09:00:00Z",
"Duration": 240
}
}
}
}
Example 37: ServiceBridge - Update Work Order
Update an existing work order
{
"automationType": "servicebridge",
"nodeId": "servicebridge-update-work-order",
"nodeParams": {
"action": "update_work_order",
"params": {
"workOrderId": "300",
"input": {
"SparseUpdate": true,
"Version": 1,
"Status": "InProgress",
"UpdateStatus": true
}
}
}
}
Example 38: ServiceBridge - Delete Work Order
Delete a work order
{
"automationType": "servicebridge",
"nodeId": "servicebridge-delete-work-order",
"nodeParams": {
"action": "delete_work_order",
"params": {
"workOrderId": "300"
}
}
}
Example 39: ServiceBridge - Get Work Order Documents
List documents for a work order
{
"automationType": "servicebridge",
"nodeId": "servicebridge-get-work-order-documents",
"nodeParams": {
"action": "get_work_order_documents",
"params": {
"workOrderId": "300"
}
}
}
Example 40: ServiceBridge - Get Work Order Document
Get a specific document
{
"automationType": "servicebridge",
"nodeId": "servicebridge-get-work-order-document",
"nodeParams": {
"action": "get_work_order_document",
"params": {
"workOrderId": "300",
"documentId": "400"
}
}
}
Example 41: ServiceBridge - Get Work Order Photos
List photos for a work order
{
"automationType": "servicebridge",
"nodeId": "servicebridge-get-work-order-photos",
"nodeParams": {
"action": "get_work_order_photos",
"params": {
"workOrderId": "300"
}
}
}
Example 42: ServiceBridge - Get Work Order Review
Get the review for a work order
{
"automationType": "servicebridge",
"nodeId": "servicebridge-get-work-order-review",
"nodeParams": {
"action": "get_work_order_review",
"params": {
"workOrderId": "300"
}
}
}
Example 43: ServiceBridge - List Work Order Reviews
Get a list of all work order reviews
{
"automationType": "servicebridge",
"nodeId": "servicebridge-list-work-order-reviews",
"nodeParams": {
"action": "list_work_order_reviews",
"params": {
"page": 1,
"pageSize": 50
}
}
}
Example 44: ServiceBridge - List Teams
Get a list of all teams
{
"automationType": "servicebridge",
"nodeId": "servicebridge-list-teams",
"nodeParams": {
"action": "list_teams",
"params": {
"page": 1,
"pageSize": 50
}
}
}
Example 45: ServiceBridge - Get Team
Get a specific team
{
"automationType": "servicebridge",
"nodeId": "servicebridge-get-team",
"nodeParams": {
"action": "get_team",
"params": {
"teamId": "500"
}
}
}
Example 46: ServiceBridge - List Personnel
Get a list of all employees
{
"automationType": "servicebridge",
"nodeId": "servicebridge-list-personnel",
"nodeParams": {
"action": "list_personnel",
"params": {
"page": 1,
"pageSize": 50
}
}
}
Example 47: ServiceBridge - Get Personnel
Get a specific employee
{
"automationType": "servicebridge",
"nodeId": "servicebridge-get-personnel",
"nodeParams": {
"action": "get_personnel",
"params": {
"personnelId": "600"
}
}
}
Example 48: ServiceBridge - List Inventory
Get a paginated list of inventory items
{
"automationType": "servicebridge",
"nodeId": "servicebridge-list-inventory",
"nodeParams": {
"action": "list_inventory",
"params": {
"page": 1,
"pageSize": 50
}
}
}
Example 49: ServiceBridge - Get Inventory Item
Get a specific inventory item
{
"automationType": "servicebridge",
"nodeId": "servicebridge-get-inventory-item",
"nodeParams": {
"action": "get_inventory_item",
"params": {
"inventoryId": "700"
}
}
}
Example 50: ServiceBridge - Delete Inventory Item
Delete an inventory item
{
"automationType": "servicebridge",
"nodeId": "servicebridge-delete-inventory-item",
"nodeParams": {
"action": "delete_inventory_item",
"params": {
"inventoryId": "700"
}
}
}
Example 51: ServiceBridge - Create Product
Create a new product
{
"automationType": "servicebridge",
"nodeId": "servicebridge-create-product",
"nodeParams": {
"action": "create_product",
"params": {
"input": {
"Name": "Insulation Roll",
"Price": 49.99,
"Type": "Product"
}
}
}
}
Example 52: ServiceBridge - Update Product
Update an existing product
{
"automationType": "servicebridge",
"nodeId": "servicebridge-update-product",
"nodeParams": {
"action": "update_product",
"params": {
"productId": "700",
"input": {
"SparseUpdate": true,
"Version": 1,
"Price": 54.99,
"UpdatePrice": true
}
}
}
}
Example 53: ServiceBridge - Create Service Item
Create a new service item
{
"automationType": "servicebridge",
"nodeId": "servicebridge-create-inventory-service",
"nodeParams": {
"action": "create_inventory_service",
"params": {
"input": {
"Name": "Installation Labor",
"Price": 85,
"Type": "Service"
}
}
}
}
Example 54: ServiceBridge - Update Service Item
Update an existing service item
{
"automationType": "servicebridge",
"nodeId": "servicebridge-update-inventory-service",
"nodeParams": {
"action": "update_inventory_service",
"params": {
"serviceId": "800",
"input": {
"SparseUpdate": true,
"Version": 1
}
}
}
}
Example 55: ServiceBridge - List Inventory Groups
Get all inventory groups
{
"automationType": "servicebridge",
"nodeId": "servicebridge-list-inventory-groups",
"nodeParams": {
"action": "list_inventory_groups",
"params": {}
}
}
Example 56: ServiceBridge - Create Inventory Group
Create a new inventory group
{
"automationType": "servicebridge",
"nodeId": "servicebridge-create-inventory-group",
"nodeParams": {
"action": "create_inventory_group",
"params": {
"input": {
"Name": "Insulation Materials"
}
}
}
}
Example 57: ServiceBridge - Update Inventory Group
Update an inventory group
{
"automationType": "servicebridge",
"nodeId": "servicebridge-update-inventory-group",
"nodeParams": {
"action": "update_inventory_group",
"params": {
"groupId": "900",
"input": {
"SparseUpdate": true,
"Version": 1,
"Name": "Updated Group Name",
"UpdateName": true
}
}
}
}
Example 58: ServiceBridge - Delete Inventory Group
Delete an inventory group
{
"automationType": "servicebridge",
"nodeId": "servicebridge-delete-inventory-group",
"nodeParams": {
"action": "delete_inventory_group",
"params": {
"groupId": "900"
}
}
}
Example 59: ServiceBridge - List Charge Types
Get all charge types
{
"automationType": "servicebridge",
"nodeId": "servicebridge-list-charge-types",
"nodeParams": {
"action": "list_charge_types",
"params": {}
}
}
Example 60: ServiceBridge - Create Charge Type
Create a new charge type
{
"automationType": "servicebridge",
"nodeId": "servicebridge-create-charge-type",
"nodeParams": {
"action": "create_charge_type",
"params": {
"input": {
"Name": "Expedited Service"
}
}
}
}
Example 61: ServiceBridge - Update Charge Type
Update a charge type
{
"automationType": "servicebridge",
"nodeId": "servicebridge-update-charge-type",
"nodeParams": {
"action": "update_charge_type",
"params": {
"chargeTypeId": "1000",
"input": {
"SparseUpdate": true,
"Version": 1
}
}
}
}
Example 62: ServiceBridge - Delete Charge Type
Delete a charge type
{
"automationType": "servicebridge",
"nodeId": "servicebridge-delete-charge-type",
"nodeParams": {
"action": "delete_charge_type",
"params": {
"chargeTypeId": "1000"
}
}
}
Example 63: ServiceBridge - List Units
Get all measurement units
{
"automationType": "servicebridge",
"nodeId": "servicebridge-list-units",
"nodeParams": {
"action": "list_units",
"params": {}
}
}
Example 64: ServiceBridge - Create Unit
Create a new measurement unit
{
"automationType": "servicebridge",
"nodeId": "servicebridge-create-unit",
"nodeParams": {
"action": "create_unit",
"params": {
"input": {
"Name": "Square Foot",
"Abbreviation": "sq ft"
}
}
}
}
Example 65: ServiceBridge - Update Unit
Update a measurement unit
{
"automationType": "servicebridge",
"nodeId": "servicebridge-update-unit",
"nodeParams": {
"action": "update_unit",
"params": {
"unitId": "1100",
"input": {
"SparseUpdate": true,
"Version": 1
}
}
}
}
Example 66: ServiceBridge - Delete Unit
Delete a measurement unit
{
"automationType": "servicebridge",
"nodeId": "servicebridge-delete-unit",
"nodeParams": {
"action": "delete_unit",
"params": {
"unitId": "1100"
}
}
}
Example 67: ServiceBridge - List Invoices
Get a paginated list of invoices
{
"automationType": "servicebridge",
"nodeId": "servicebridge-list-invoices",
"nodeParams": {
"action": "list_invoices",
"params": {
"page": 1,
"pageSize": 50
}
}
}
Example 68: ServiceBridge - Get Invoice
Get a specific invoice
{
"automationType": "servicebridge",
"nodeId": "servicebridge-get-invoice",
"nodeParams": {
"action": "get_invoice",
"params": {
"invoiceId": "1200"
}
}
}
Example 69: ServiceBridge - List Payments
Get a paginated list of payments
{
"automationType": "servicebridge",
"nodeId": "servicebridge-list-payments",
"nodeParams": {
"action": "list_payments",
"params": {
"page": 1,
"pageSize": 50
}
}
}
Example 70: ServiceBridge - Get Payment
Get a specific payment
{
"automationType": "servicebridge",
"nodeId": "servicebridge-get-payment",
"nodeParams": {
"action": "get_payment",
"params": {
"paymentId": "1300"
}
}
}
Example 71: ServiceBridge - Create Payment
Record a new payment
{
"automationType": "servicebridge",
"nodeId": "servicebridge-create-payment",
"nodeParams": {
"action": "create_payment",
"params": {
"input": {
"Amount": 500,
"InvoiceId": 1200,
"PaymentMethodId": 1
}
}
}
}
Example 72: ServiceBridge - Update Payment
Update a payment record
{
"automationType": "servicebridge",
"nodeId": "servicebridge-update-payment",
"nodeParams": {
"action": "update_payment",
"params": {
"paymentId": "1300",
"input": {
"SparseUpdate": true,
"Version": 1
}
}
}
}
Example 73: ServiceBridge - Delete Payment
Delete a payment record
{
"automationType": "servicebridge",
"nodeId": "servicebridge-delete-payment",
"nodeParams": {
"action": "delete_payment",
"params": {
"paymentId": "1300"
}
}
}
Example 74: ServiceBridge - List Payment Methods
Get available payment methods
{
"automationType": "servicebridge",
"nodeId": "servicebridge-list-payment-methods",
"nodeParams": {
"action": "list_payment_methods",
"params": {}
}
}
Example 75: ServiceBridge - List Branches
Get all branches/locations
{
"automationType": "servicebridge",
"nodeId": "servicebridge-list-branches",
"nodeParams": {
"action": "list_branches",
"params": {
"page": 1,
"pageSize": 50
}
}
}
Example 76: ServiceBridge - Get Branch
Get a specific branch
{
"automationType": "servicebridge",
"nodeId": "servicebridge-get-branch",
"nodeParams": {
"action": "get_branch",
"params": {
"branchId": "1400"
}
}
}
Example 77: ServiceBridge - Create Branch
Create a new branch
{
"automationType": "servicebridge",
"nodeId": "servicebridge-create-branch",
"nodeParams": {
"action": "create_branch",
"params": {
"input": {
"Name": "Columbus Office",
"AddressLine1": "456 Oak Ave",
"City": "Columbus",
"State": "OH"
}
}
}
}
Example 78: ServiceBridge - Update Branch
Update a branch
{
"automationType": "servicebridge",
"nodeId": "servicebridge-update-branch",
"nodeParams": {
"action": "update_branch",
"params": {
"branchId": "1400",
"input": {
"SparseUpdate": true,
"Version": 1
}
}
}
}
Example 79: ServiceBridge - Delete Branch
Delete a branch
{
"automationType": "servicebridge",
"nodeId": "servicebridge-delete-branch",
"nodeParams": {
"action": "delete_branch",
"params": {
"branchId": "1400"
}
}
}
Example 80: ServiceBridge - List Companies
Get all companies in hierarchy
{
"automationType": "servicebridge",
"nodeId": "servicebridge-list-companies",
"nodeParams": {
"action": "list_companies",
"params": {}
}
}
Example 81: ServiceBridge - Get Company
Get company details
{
"automationType": "servicebridge",
"nodeId": "servicebridge-get-company",
"nodeParams": {
"action": "get_company",
"params": {
"companyId": "1500"
}
}
}
Example 82: ServiceBridge - List Marketing Campaigns
Get all marketing campaigns
{
"automationType": "servicebridge",
"nodeId": "servicebridge-list-marketing-campaigns",
"nodeParams": {
"action": "list_marketing_campaigns",
"params": {
"page": 1,
"pageSize": 50
}
}
}
Example 83: ServiceBridge - Get Marketing Campaign
Get a specific campaign
{
"automationType": "servicebridge",
"nodeId": "servicebridge-get-marketing-campaign",
"nodeParams": {
"action": "get_marketing_campaign",
"params": {
"campaignId": "1600"
}
}
}
Example 84: ServiceBridge - Create Marketing Campaign
Create a new campaign
{
"automationType": "servicebridge",
"nodeId": "servicebridge-create-marketing-campaign",
"nodeParams": {
"action": "create_marketing_campaign",
"params": {
"input": {
"Name": "Winter Special 2026",
"Description": "20% off insulation"
}
}
}
}
Example 85: ServiceBridge - Update Marketing Campaign
Update a campaign
{
"automationType": "servicebridge",
"nodeId": "servicebridge-update-marketing-campaign",
"nodeParams": {
"action": "update_marketing_campaign",
"params": {
"campaignId": "1600",
"input": {
"SparseUpdate": true,
"Version": 1
}
}
}
}
Example 86: ServiceBridge - Delete Marketing Campaign
Delete a campaign
{
"automationType": "servicebridge",
"nodeId": "servicebridge-delete-marketing-campaign",
"nodeParams": {
"action": "delete_marketing_campaign",
"params": {
"campaignId": "1600"
}
}
}
Example 87: ServiceBridge - Get Active Campaigns
Get currently active campaigns
{
"automationType": "servicebridge",
"nodeId": "servicebridge-get-active-marketing-campaigns",
"nodeParams": {
"action": "get_active_marketing_campaigns",
"params": {}
}
}
Example 88: ServiceBridge - List Marketing Categories
Get all marketing categories
{
"automationType": "servicebridge",
"nodeId": "servicebridge-list-marketing-categories",
"nodeParams": {
"action": "list_marketing_categories",
"params": {
"page": 1,
"pageSize": 50
}
}
}
Example 89: ServiceBridge - Get Marketing Category
Get a specific category
{
"automationType": "servicebridge",
"nodeId": "servicebridge-get-marketing-category",
"nodeParams": {
"action": "get_marketing_category",
"params": {
"categoryId": "1700"
}
}
}
Example 90: ServiceBridge - Create Marketing Category
Create a new category
{
"automationType": "servicebridge",
"nodeId": "servicebridge-create-marketing-category",
"nodeParams": {
"action": "create_marketing_category",
"params": {
"input": {
"Name": "Digital Marketing"
}
}
}
}
Example 91: ServiceBridge - Update Marketing Category
Update a category
{
"automationType": "servicebridge",
"nodeId": "servicebridge-update-marketing-category",
"nodeParams": {
"action": "update_marketing_category",
"params": {
"categoryId": "1700",
"input": {
"SparseUpdate": true,
"Version": 1
}
}
}
}
Example 92: ServiceBridge - Delete Marketing Category
Delete a category
{
"automationType": "servicebridge",
"nodeId": "servicebridge-delete-marketing-category",
"nodeParams": {
"action": "delete_marketing_category",
"params": {
"categoryId": "1700"
}
}
}
Example 93: ServiceBridge - List Job Categories
Get all job categories
{
"automationType": "servicebridge",
"nodeId": "servicebridge-list-job-categories",
"nodeParams": {
"action": "list_job_categories",
"params": {
"page": 1,
"pageSize": 50
}
}
}
Example 94: ServiceBridge - Get Job Category
Get a specific job category
{
"automationType": "servicebridge",
"nodeId": "servicebridge-get-job-category",
"nodeParams": {
"action": "get_job_category",
"params": {
"categoryId": "1800"
}
}
}
Example 95: ServiceBridge - Create Job Category
Create a new job category
{
"automationType": "servicebridge",
"nodeId": "servicebridge-create-job-category",
"nodeParams": {
"action": "create_job_category",
"params": {
"input": {
"Name": "Insulation",
"Description": "Insulation installation jobs"
}
}
}
}
Example 96: ServiceBridge - Update Job Category
Update a job category
{
"automationType": "servicebridge",
"nodeId": "servicebridge-update-job-category",
"nodeParams": {
"action": "update_job_category",
"params": {
"categoryId": "1800",
"input": {
"SparseUpdate": true,
"Version": 1
}
}
}
}
Example 97: ServiceBridge - Delete Job Category
Delete a job category
{
"automationType": "servicebridge",
"nodeId": "servicebridge-delete-job-category",
"nodeParams": {
"action": "delete_job_category",
"params": {
"categoryId": "1800"
}
}
}
Example 98: ServiceBridge - List Job Templates
Get all job templates
{
"automationType": "servicebridge",
"nodeId": "servicebridge-list-job-templates",
"nodeParams": {
"action": "list_job_templates",
"params": {
"page": 1,
"pageSize": 50
}
}
}
Example 99: ServiceBridge - Get Job Template
Get a specific job template
{
"automationType": "servicebridge",
"nodeId": "servicebridge-get-job-template",
"nodeParams": {
"action": "get_job_template",
"params": {
"templateId": "1900"
}
}
}
Example 100: ServiceBridge - List Leads
Get a paginated list of leads
{
"automationType": "servicebridge",
"nodeId": "servicebridge-list-leads",
"nodeParams": {
"action": "list_leads",
"params": {
"page": 1,
"pageSize": 50
}
}
}
Example 101: ServiceBridge - Get Lead
Get a specific lead
{
"automationType": "servicebridge",
"nodeId": "servicebridge-get-lead",
"nodeParams": {
"action": "get_lead",
"params": {
"leadId": "2000"
}
}
}
Example 102: ServiceBridge - Create Lead
Create a new lead
{
"automationType": "servicebridge",
"nodeId": "servicebridge-create-lead",
"nodeParams": {
"action": "create_lead",
"params": {
"input": {
"Name": "New Prospect",
"PhoneNumber": "555-444-3333"
}
}
}
}
Example 103: ServiceBridge - List Service Agreements
Get all service agreements
{
"automationType": "servicebridge",
"nodeId": "servicebridge-list-service-agreements",
"nodeParams": {
"action": "list_service_agreements",
"params": {
"page": 1,
"pageSize": 50
}
}
}
Example 104: ServiceBridge - Get Service Agreement
Get a specific agreement
{
"automationType": "servicebridge",
"nodeId": "servicebridge-get-service-agreement",
"nodeParams": {
"action": "get_service_agreement",
"params": {
"agreementId": "2100"
}
}
}
Example 105: ServiceBridge - Create Service Agreement
Create a new agreement
{
"automationType": "servicebridge",
"nodeId": "servicebridge-create-service-agreement",
"nodeParams": {
"action": "create_service_agreement",
"params": {
"input": {
"Name": "Annual Maintenance",
"CustomerId": 123
}
}
}
}
Example 106: ServiceBridge - Update Service Agreement
Update an agreement
{
"automationType": "servicebridge",
"nodeId": "servicebridge-update-service-agreement",
"nodeParams": {
"action": "update_service_agreement",
"params": {
"agreementId": "2100",
"input": {
"SparseUpdate": true,
"Version": 1
}
}
}
}
Example 107: ServiceBridge - Delete Service Agreement
Delete an agreement
{
"automationType": "servicebridge",
"nodeId": "servicebridge-delete-service-agreement",
"nodeParams": {
"action": "delete_service_agreement",
"params": {
"agreementId": "2100"
}
}
}
Example 108: ServiceBridge - List Service Plans
Get all service plans
{
"automationType": "servicebridge",
"nodeId": "servicebridge-list-service-plans",
"nodeParams": {
"action": "list_service_plans",
"params": {
"page": 1,
"pageSize": 50
}
}
}
Example 109: ServiceBridge - Get Service Plan
Get a specific plan
{
"automationType": "servicebridge",
"nodeId": "servicebridge-get-service-plan",
"nodeParams": {
"action": "get_service_plan",
"params": {
"planId": "2200"
}
}
}
Example 110: ServiceBridge - Create Service Plan
Create a new plan
{
"automationType": "servicebridge",
"nodeId": "servicebridge-create-service-plan",
"nodeParams": {
"action": "create_service_plan",
"params": {
"input": {
"Name": "Premium Plan"
}
}
}
}
Example 111: ServiceBridge - Update Service Plan
Update a plan
{
"automationType": "servicebridge",
"nodeId": "servicebridge-update-service-plan",
"nodeParams": {
"action": "update_service_plan",
"params": {
"planId": "2200",
"input": {
"SparseUpdate": true,
"Version": 1
}
}
}
}
Example 112: ServiceBridge - Delete Service Plan
Delete a plan
{
"automationType": "servicebridge",
"nodeId": "servicebridge-delete-service-plan",
"nodeParams": {
"action": "delete_service_plan",
"params": {
"planId": "2200"
}
}
}
Example 113: ServiceBridge - List Tasks
Get a paginated list of tasks
{
"automationType": "servicebridge",
"nodeId": "servicebridge-list-tasks",
"nodeParams": {
"action": "list_tasks",
"params": {
"page": 1,
"pageSize": 50
}
}
}
Example 114: ServiceBridge - Get Task
Get a specific task
{
"automationType": "servicebridge",
"nodeId": "servicebridge-get-task",
"nodeParams": {
"action": "get_task",
"params": {
"taskId": "2300"
}
}
}
Example 115: ServiceBridge - Create Task
Create a new task
{
"automationType": "servicebridge",
"nodeId": "servicebridge-create-task",
"nodeParams": {
"action": "create_task",
"params": {
"input": {
"Title": "Follow up call",
"DueDate": "2026-01-30"
}
}
}
}
Example 116: ServiceBridge - Update Task
Update a task
{
"automationType": "servicebridge",
"nodeId": "servicebridge-update-task",
"nodeParams": {
"action": "update_task",
"params": {
"taskId": "2300",
"input": {
"SparseUpdate": true,
"Version": 1,
"Status": "Completed",
"UpdateStatus": true
}
}
}
}
Example 117: ServiceBridge - List Activity Notes
Get notes for an entity
{
"automationType": "servicebridge",
"nodeId": "servicebridge-list-activity-notes",
"nodeParams": {
"action": "list_activity_notes",
"params": {
"entityType": "Customer",
"entityId": "123",
"page": 1,
"pageSize": 50
}
}
}
Example 118: ServiceBridge - Get Activity Note
Get a specific note
{
"automationType": "servicebridge",
"nodeId": "servicebridge-get-activity-note",
"nodeParams": {
"action": "get_activity_note",
"params": {
"noteId": "2400"
}
}
}
Example 119: ServiceBridge - Create Activity Note
Create a new note
{
"automationType": "servicebridge",
"nodeId": "servicebridge-create-activity-note",
"nodeParams": {
"action": "create_activity_note",
"params": {
"input": {
"EntityType": "Customer",
"EntityId": 123,
"Note": "Customer called about installation schedule"
}
}
}
}
Example 120: ServiceBridge - Update Activity Note
Update a note
{
"automationType": "servicebridge",
"nodeId": "servicebridge-update-activity-note",
"nodeParams": {
"action": "update_activity_note",
"params": {
"noteId": "2400",
"input": {
"Note": "Updated note content"
}
}
}
}
Example 121: ServiceBridge - Delete Activity Note
Delete a note
{
"automationType": "servicebridge",
"nodeId": "servicebridge-delete-activity-note",
"nodeParams": {
"action": "delete_activity_note",
"params": {
"noteId": "2400"
}
}
}
Example 122: ServiceBridge - List Custom Fields
Get custom fields by entity type (required: Job, Customer, Part, Personnel, Task, JobPart, Equipment, Companies, Location)
{
"automationType": "servicebridge",
"nodeId": "servicebridge-list-custom-fields",
"nodeParams": {
"action": "list_custom_fields",
"params": {
"page": 1,
"pageSize": 50,
"type": "Customer"
}
}
}
Example 123: ServiceBridge - Get Custom Field
Get a specific custom field
{
"automationType": "servicebridge",
"nodeId": "servicebridge-get-custom-field",
"nodeParams": {
"action": "get_custom_field",
"params": {
"fieldId": "2500"
}
}
}
Example 124: ServiceBridge - Create Custom Field
Create a new custom field
{
"automationType": "servicebridge",
"nodeId": "servicebridge-create-custom-field",
"nodeParams": {
"action": "create_custom_field",
"params": {
"input": {
"Name": "Lead Source",
"FieldType": "Text"
}
}
}
}
Example 125: ServiceBridge - Update Custom Field
Update a custom field
{
"automationType": "servicebridge",
"nodeId": "servicebridge-update-custom-field",
"nodeParams": {
"action": "update_custom_field",
"params": {
"fieldId": "2500",
"input": {
"SparseUpdate": true,
"Version": 1
}
}
}
}
Example 126: ServiceBridge - Delete Custom Field
Delete a custom field
{
"automationType": "servicebridge",
"nodeId": "servicebridge-delete-custom-field",
"nodeParams": {
"action": "delete_custom_field",
"params": {
"fieldId": "2500"
}
}
}
Example 127: ServiceBridge - List Custom Field Groups
Get custom field groups by entity type (required: Job, Customer, Part, Personnel, Task, JobPart, Equipment, Companies, Location)
{
"automationType": "servicebridge",
"nodeId": "servicebridge-list-custom-field-groups",
"nodeParams": {
"action": "list_custom_field_groups",
"params": {
"page": 1,
"pageSize": 50,
"type": "Customer"
}
}
}
Example 128: ServiceBridge - Get Custom Field Group
Get a specific group
{
"automationType": "servicebridge",
"nodeId": "servicebridge-get-custom-field-group",
"nodeParams": {
"action": "get_custom_field_group",
"params": {
"groupId": "2600"
}
}
}
Example 129: ServiceBridge - Create Custom Field Group
Create a new group
{
"automationType": "servicebridge",
"nodeId": "servicebridge-create-custom-field-group",
"nodeParams": {
"action": "create_custom_field_group",
"params": {
"input": {
"Name": "Lead Information"
}
}
}
}
Example 130: ServiceBridge - Update Custom Field Group
Update a group
{
"automationType": "servicebridge",
"nodeId": "servicebridge-update-custom-field-group",
"nodeParams": {
"action": "update_custom_field_group",
"params": {
"groupId": "2600",
"input": {
"SparseUpdate": true,
"Version": 1
}
}
}
}
Example 131: ServiceBridge - Delete Custom Field Group
Delete a group
{
"automationType": "servicebridge",
"nodeId": "servicebridge-delete-custom-field-group",
"nodeParams": {
"action": "delete_custom_field_group",
"params": {
"groupId": "2600"
}
}
}
Example 132: ServiceBridge - List Assets
Get a paginated list of assets
{
"automationType": "servicebridge",
"nodeId": "servicebridge-list-assets",
"nodeParams": {
"action": "list_assets",
"params": {
"page": 1,
"pageSize": 50
}
}
}
Example 133: ServiceBridge - List Accounting Accounts
Get all accounting accounts
{
"automationType": "servicebridge",
"nodeId": "servicebridge-list-accounting-accounts",
"nodeParams": {
"action": "list_accounting_accounts",
"params": {
"page": 1,
"pageSize": 50
}
}
}
Example 134: ServiceBridge - List Sales Representatives
Get all sales reps
{
"automationType": "servicebridge",
"nodeId": "servicebridge-list-sales-representatives",
"nodeParams": {
"action": "list_sales_representatives",
"params": {
"page": 1,
"pageSize": 50
}
}
}
Example 135: ServiceBridge - List Taxes
Get all tax configurations
{
"automationType": "servicebridge",
"nodeId": "servicebridge-list-taxes",
"nodeParams": {
"action": "list_taxes",
"params": {}
}
}
Example 136: ServiceBridge - List Terms
Get all payment terms
{
"automationType": "servicebridge",
"nodeId": "servicebridge-list-terms",
"nodeParams": {
"action": "list_terms",
"params": {}
}
}
Example 137: ServiceBridge - Get Company Statistics
Get company-wide statistics
{
"automationType": "servicebridge",
"nodeId": "servicebridge-get-company-statistics",
"nodeParams": {
"action": "get_company_statistics",
"params": {}
}
}
Example 138: ServiceBridge - Get Invoice Statistics
Get invoice-related statistics
{
"automationType": "servicebridge",
"nodeId": "servicebridge-get-invoice-statistics",
"nodeParams": {
"action": "get_invoice_statistics",
"params": {}
}
}
Example 139: ServiceBridge - Get Job Statistics
Get job-related statistics
{
"automationType": "servicebridge",
"nodeId": "servicebridge-get-job-statistics",
"nodeParams": {
"action": "get_job_statistics",
"params": {}
}
}
Example 140: ServiceBridge - Get Payment Statistics
Get payment-related statistics
{
"automationType": "servicebridge",
"nodeId": "servicebridge-get-payment-statistics",
"nodeParams": {
"action": "get_payment_statistics",
"params": {}
}
}
Example 141: ServiceBridge - Get Report
Generate a report
{
"automationType": "servicebridge",
"nodeId": "servicebridge-get-report",
"nodeParams": {
"action": "get_report",
"params": {
"reportType": "Summary"
}
}
}
Example 142: ServiceBridge - Get Active Users History
Get user activity history
{
"automationType": "servicebridge",
"nodeId": "servicebridge-get-active-users-history",
"nodeParams": {
"action": "get_active_users_history",
"params": {
"startDate": "2026-01-01",
"endDate": "2026-01-31"
}
}
}
Third-Party Documentation