--- canonical_url: "https://docs.composio.dev/toolkits/housecall_pro" markdown_url: "https://docs.composio.dev/toolkits/housecall_pro.md" product: "platform" version: null last_updated: null --- # Housecall Pro Housecall Pro provides field service businesses with customer, job, scheduling, estimate, invoice, price book, and operational management APIs. - **Category:** crm - **Auth:** API_KEY - **Composio-managed OAuth available?** N/A - **Tools:** 95 - **Triggers:** 0 - **Slug:** `HOUSECALL_PRO` - **Version:** 00000000_00 ## Tools ### Create Estimate option attachment **Slug:** `HOUSECALL_PRO_ADD_ESTIMATE_OPTION_ATTACHMENT` Create a new estimate option attachment #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file` | object | Yes | Binary file to attach to the estimate option. | | `option_id` | string | Yes | Housecall Pro estimate option ID. | | `estimate_id` | string | Yes | Housecall Pro estimate ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add an Estimate Option Note **Slug:** `HOUSECALL_PRO_ADD_ESTIMATE_OPTION_NOTE` Create a note attached to an existing Housecall Pro estimate option. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `content` | string | Yes | Content of the note to add to the estimate option. | | `option_id` | string | Yes | Housecall Pro estimate option ID. | | `estimate_id` | string | Yes | Housecall Pro estimate ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add an Attachment to a Job **Slug:** `HOUSECALL_PRO_ADD_JOB_ATTACHMENT` Add an attachment to a Housecall Pro job. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file` | object | Yes | File to attach to the job. | | `job_id` | string | Yes | Housecall Pro job ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add a Line Item to a Job **Slug:** `HOUSECALL_PRO_ADD_JOB_LINE_ITEM` Add one pricing line item to a Housecall Pro job. Use the bulk update operation instead when adding multiple line items to the same job. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `kind` | string ("materials" | "labor" | "fixed gratuity" | "fixed discount" | "percent discount") | No | Pricing behavior of the line item. | | `name` | string | Yes | Line-item name. | | `job_id` | string | Yes | Housecall Pro job ID. | | `taxable` | boolean | No | Whether tax applies to the line item. | | `quantity` | number | No | Number of units, with up to two decimal places. | | `unit_cost` | number | No | Direct cost for one unit, in cents. | | `unit_price` | number | No | Selling price for one unit, in cents. | | `description` | string | No | Customer-facing line-item description. | | `service_item_id` | string | No | Related service or price-book item ID. | | `service_item_type` | string ("market_place" | "organizational" | "pricebook_material") | No | Source catalog type of the related service item. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add a Note to a Job **Slug:** `HOUSECALL_PRO_ADD_JOB_NOTE` Create a note attached to an existing Housecall Pro job. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `job_id` | string | Yes | Housecall Pro job ID. | | `content` | string | Yes | Content of the note to add to the job. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add Job Tags **Slug:** `HOUSECALL_PRO_ADD_JOB_TAGS` Add an existing reusable tag to a Housecall Pro job. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `job_id` | string | Yes | Housecall Pro job ID. | | `tag_id` | string | Yes | ID of the existing Housecall Pro tag to add to the job. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Approve Estimate Options **Slug:** `HOUSECALL_PRO_APPROVE_ESTIMATE_OPTIONS` Irreversibly mark Housecall Pro estimate options as approved by the Pro. When automatic estimate-to-job copying is enabled, the approved options are copied into one job. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `option_ids` | array | Yes | Housecall Pro estimate option IDs to approve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Bulk Lock Jobs **Slug:** `HOUSECALL_PRO_BULK_LOCK_JOBS` Irreversibly lock Housecall Pro jobs whose scheduled start or completion time falls in an inclusive time range for the requested statuses. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `statuses` | array | Yes | Statuses to lock. completed matches completion time; scheduled and in_progress match schedule start. | | `ending_at` | string | Yes | Inclusive end of the ISO 8601 time range. | | `starting_at` | string | Yes | Inclusive start of the ISO 8601 time range. Jobs match by scheduled start or completion time according to status. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Bulk Update Estimate Option Line Items **Slug:** `HOUSECALL_PRO_BULK_UPDATE_ESTIMATE_OPTION_LINE_ITEMS` Bulk update line items for a Housecall Pro estimate option. Existing items may be updated by ID, and items without an ID are created. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `option_id` | string | Yes | Estimate option ID. | | `line_items` | array | Yes | One or more line items to update; items without an ID are created. | | `estimate_id` | string | Yes | Housecall Pro estimate ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Bulk Update Job Input Materials **Slug:** `HOUSECALL_PRO_BULK_UPDATE_JOB_INPUT_MATERIALS` Bulk update input materials for a Housecall Pro job. Existing entries may be updated by UUID, and entries without a UUID are created. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `job_id` | string | Yes | Housecall Pro job ID. | | `job_input_materials` | array | Yes | One or more job input materials to update. Entries without a UUID are created. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Bulk Update Job Line Items **Slug:** `HOUSECALL_PRO_BULK_UPDATE_JOB_LINE_ITEMS` Bulk update a Housecall Pro job's line items. Existing items may be updated by ID, and items without an ID are created. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `job_id` | string | Yes | Housecall Pro job ID. | | `line_items` | array | Yes | One or more line items to update. Items without an ID are created; an empty list is not accepted. | | `append_line_items` | boolean | No | Set true to keep existing job line items omitted from line_items. Set false, or omit this field, to delete omitted existing line items. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Convert Lead **Slug:** `HOUSECALL_PRO_CONVERT_LEAD` Irreversibly convert an existing Housecall Pro lead into either a job or an estimate and return the new resource ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `lead_id` | string | Yes | Housecall Pro lead ID. | | `target_type` | string ("estimate" | "job") | Yes | Resource type to create from the lead. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Customer **Slug:** `HOUSECALL_PRO_CREATE_CUSTOMER` Create a Housecall Pro customer, optionally with addresses, tags, lead source, and notes. At least one name, email, or phone field is required. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tags` | array | No | Tag names to assign to the customer. | | `email` | string | No | Customer email address. | | `notes` | string | No | Notes to store on the customer. | | `company` | string | No | Customer company name. | | `addresses` | array | No | Service or billing addresses for the customer. | | `last_name` | string | No | Customer last name. | | `first_name` | string | No | Customer first name. | | `home_number` | string | No | Customer home phone number. | | `lead_source` | string | No | Lead source name used for attribution. | | `work_number` | string | No | Customer work phone number. | | `mobile_number` | string | No | Customer mobile phone number. | | `notifications_enabled` | boolean | No | Whether customer notifications are enabled. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create an Address on a Customer **Slug:** `HOUSECALL_PRO_CREATE_CUSTOMER_ADDRESS` Create an address on a customer. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `zip` | string | Yes | Postal or ZIP code. | | `city` | string | Yes | City. | | `state` | string | Yes | State or region. | | `street` | string | Yes | Street address. | | `country` | string | Yes | Country. | | `latitude` | string | No | Latitude as a number or numeric string. | | `longitude` | string | No | Longitude as a number or numeric string. | | `customer_id` | string | Yes | Housecall Pro customer ID. | | `street_line_2` | string | No | Additional street address information. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Estimate **Slug:** `HOUSECALL_PRO_CREATE_ESTIMATE` Create a Housecall Pro estimate for a customer or address with at least one pricing option and optional tax, schedule, assigned employees, and estimate fields. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tax` | object | No | Tax configuration for the estimate. | | `note` | string | No | Internal estimate note. | | `address` | object | No | Inline address for the estimate. | | `message` | string | No | Message associated with the estimate. | | `options` | array | Yes | At least one initial pricing option required by the live provider. | | `schedule` | object | No | Initial schedule for the estimate. | | `address_id` | string | No | Existing address ID belonging to the customer. | | `customer_id` | string | No | Existing Housecall Pro customer ID. | | `lead_source` | string | No | Lead source name used for attribution. | | `estimate_fields` | object | No | Configured job type and business unit IDs. | | `estimate_number` | integer | No | Unique estimate number; Housecall Pro generates one when omitted. | | `assigned_employee_ids` | array | No | Employee IDs to assign to the estimate. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Estimate Option **Slug:** `HOUSECALL_PRO_CREATE_ESTIMATE_OPTION` Add a named pricing option with optional line items and tax settings to an existing Housecall Pro estimate. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tax` | object | No | Tax settings for the estimate option. | | `name` | string | Yes | Customer-facing option name. | | `line_items` | array | No | Line items to add to the estimate option. | | `estimate_id` | string | Yes | Housecall Pro estimate ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Estimate Option Link **Slug:** `HOUSECALL_PRO_CREATE_ESTIMATE_OPTION_LINK` Create a link attached to an existing Housecall Pro estimate option. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `url` | string | Yes | URL for the estimate option link. | | `title` | string | Yes | Display title for the estimate option link. | | `option_id` | string | Yes | Housecall Pro estimate option ID. | | `estimate_id` | string | Yes | Housecall Pro estimate ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Job **Slug:** `HOUSECALL_PRO_CREATE_JOB` Create a Housecall Pro job for an existing customer and address, optionally with a schedule, assigned employees, line items, tags, notes, and job fields. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tags` | array | No | Tag names to assign to the job. | | `notes` | string | No | Initial notes for the job. | | `schedule` | object | No | Initial schedule for the job. | | `address_id` | string | Yes | Existing service address ID belonging to the customer. | | `job_fields` | object | No | Configured job type and business unit IDs. | | `line_items` | array | No | Initial pricing line items for the job. | | `customer_id` | string | Yes | Existing Housecall Pro customer ID. | | `lead_source` | string | No | Lead source name used for attribution. | | `invoice_number` | integer | No | Unique invoice number; Housecall Pro generates one when omitted. | | `assigned_employee_ids` | array | No | Employee IDs to assign to the job. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Appointment **Slug:** `HOUSECALL_PRO_CREATE_JOB_APPOINTMENT` Add an appointment to a Housecall Pro job. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `job_id` | string | Yes | Housecall Pro job ID. | | `end_time` | string | Yes | Appointment end time as an ISO 8601 timestamp. | | `start_time` | string | Yes | Appointment start time as an ISO 8601 timestamp. | | `arrival_window_minutes` | integer | No | Arrival-window duration in minutes. | | `dispatched_employees_ids` | array | Yes | Housecall Pro employee IDs to dispatch to the appointment. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Job Link **Slug:** `HOUSECALL_PRO_CREATE_JOB_LINK` Create a link attached to an existing Housecall Pro job. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `url` | string | Yes | URL for the job link. | | `title` | string | Yes | Display title for the job link. | | `job_id` | string | Yes | Housecall Pro job ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Job Type **Slug:** `HOUSECALL_PRO_CREATE_JOB_TYPE` Create a job type for classifying Housecall Pro jobs and estimates. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Name of the job type to create. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Lead **Slug:** `HOUSECALL_PRO_CREATE_LEAD` Create a Housecall Pro lead for either an existing customer or an inline customer, optionally with an address, assignment, line items, notes, tags, source, and tax details. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `note` | string | No | Note to attach to the lead. | | `tags` | array | No | Tag names to assign to the lead. | | `address` | object | No | Inline address for the lead. | | `customer` | object | No | Inline customer details to use instead of an existing customer ID. | | `tax_name` | string | No | Tax name for the lead. | | `tax_rate` | integer | No | Tax rate accepted by Housecall Pro. | | `address_id` | string | No | Existing customer address ID for the lead. | | `line_items` | array | No | Initial pricing line items for the lead. | | `customer_id` | string | No | Existing Housecall Pro customer ID. | | `lead_source` | string | No | Lead source name used for attribution. | | `assigned_employee_id` | string | No | Employee ID to assign to the lead. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create a Lead Source **Slug:** `HOUSECALL_PRO_CREATE_LEAD_SOURCE` Create a lead source for attributing customers, jobs, and leads. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Name of the lead source to create. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Material **Slug:** `HOUSECALL_PRO_CREATE_MATERIAL` Create a material in a Housecall Pro price book category. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cost` | integer | Yes | Cost of the material, in cents. | | `name` | string | Yes | Name of the material to create. | | `price` | integer | Yes | Price of the material, in cents. | | `taxable` | boolean | No | Whether the material is taxable on an invoice. | | `description` | string | No | Description of the material. | | `part_number` | string | No | Part number of the material. | | `unit_of_measure` | string | No | Unit used to measure the material, such as 'each'. | | `flat_rate_enabled` | boolean | No | Whether flat-rate pricing is enabled for the material. | | `material_category_uuid` | string | Yes | UUID of the material category to create the material under. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Material Category **Slug:** `HOUSECALL_PRO_CREATE_MATERIAL_CATEGORY` Create a root or nested material category in the price book. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Name of the material category to create. | | `parent_uuid` | string | No | UUID of the parent category; omit to create a root category. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Price Form **Slug:** `HOUSECALL_PRO_CREATE_PRICE_FORM` Create a new price form in the Housecall Pro price book. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Name of the price form to create. | | `image` | string | No | Image value for the price form. | | `taxable` | boolean | No | Whether prices calculated by this form are taxable. | | `assigned` | object | No | Professionals and tags assigned to the price form. | | `question_1` | string | No | First question shown with the price form. | | `question_2` | string | No | Second question shown with the price form. | | `bookable_as` | string | No | Housecall Pro online-booking classification. | | `description` | string | No | Price-form description. | | `olb_enabled` | boolean | No | Whether the price form is enabled for online booking. | | `fields_attributes` | array | No | Configurable pricing fields to create with the form. | | `duration_in_minutes` | integer | No | Default service duration in minutes. | | `default_service_zone_id` | string | No | Default Housecall Pro service-zone ID. | | `dynamic_duration_enabled` | boolean | No | Whether selected fields and options dynamically determine duration. | | `automatically_add_to_new_job` | boolean | No | Whether to add this price form automatically to new jobs. | | `service_area_pricing_enabled` | boolean | No | Whether pricing varies by service area. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create a Tag **Slug:** `HOUSECALL_PRO_CREATE_TAG` Create a reusable tag for classifying customers, jobs, and leads. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | Name of the reusable tag to create. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Webhook Subscription **Slug:** `HOUSECALL_PRO_CREATE_WEBHOOK_SUBSCRIPTION` Enable persistent external webhook delivery for the connected Housecall Pro company. Future company events begin flowing to the webhook endpoint configured for the API application; deliveries already emitted cannot be recalled or undone. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Decline Estimate Options **Slug:** `HOUSECALL_PRO_DECLINE_ESTIMATE_OPTIONS` Irreversibly mark one or more Housecall Pro estimate options as declined by the service professional. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `option_ids` | array | Yes | Housecall Pro estimate option IDs to mark as declined. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Estimate Option Note **Slug:** `HOUSECALL_PRO_DELETE_ESTIMATE_OPTION_NOTE` Permanently delete a specific note from a Housecall Pro estimate option. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `note_id` | string | Yes | Housecall Pro estimate option note ID. | | `option_id` | string | Yes | Housecall Pro estimate option ID. | | `estimate_id` | string | Yes | Housecall Pro estimate ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Appointment **Slug:** `HOUSECALL_PRO_DELETE_JOB_APPOINTMENT` Permanently delete one appointment from a Housecall Pro job. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `job_id` | string | Yes | Housecall Pro job ID. | | `appointment_id` | string | Yes | Housecall Pro appointment ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a Job Line Item **Slug:** `HOUSECALL_PRO_DELETE_JOB_LINE_ITEM` Permanently delete one line item from a Housecall Pro job. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | ID of the job line item to delete. | | `job_id` | string | Yes | Housecall Pro job ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Job Note **Slug:** `HOUSECALL_PRO_DELETE_JOB_NOTE` Permanently delete a specific note from a Housecall Pro job. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `job_id` | string | Yes | Housecall Pro job ID. | | `note_id` | string | Yes | Housecall Pro job note ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Job Schedule **Slug:** `HOUSECALL_PRO_DELETE_JOB_SCHEDULE` Erase the schedule from an existing Housecall Pro job. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `job_id` | string | Yes | Housecall Pro job ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Remove Job Tag **Slug:** `HOUSECALL_PRO_DELETE_JOB_TAG` Remove a tag from a Housecall Pro job. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `job_id` | string | Yes | Housecall Pro job ID. | | `tag_id` | string | Yes | Housecall Pro tag ID to remove from the job. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Material **Slug:** `HOUSECALL_PRO_DELETE_MATERIAL` Permanently delete an existing Housecall Pro price-book material. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `uuid` | string | Yes | UUID of the price-book material to delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Material Category **Slug:** `HOUSECALL_PRO_DELETE_MATERIAL_CATEGORY` Permanently delete an existing Housecall Pro price-book material category. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `uuid` | string | Yes | UUID of the price-book material category to delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Price Form **Slug:** `HOUSECALL_PRO_DELETE_PRICE_FORM` Permanently delete an existing Housecall Pro price form. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `uuid` | string | Yes | UUID of the price form to delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Webhook Subscription **Slug:** `HOUSECALL_PRO_DELETE_WEBHOOK_SUBSCRIPTION` Permanently remove the connected Housecall Pro company's persistent webhook delivery subscription and stop future company events. This removal cannot be undone; creating a new subscription is required to resume delivery, and events missed or already delivered cannot be recovered or recalled. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Disable Application **Slug:** `HOUSECALL_PRO_DISABLE_APPLICATION` Disable the application for the connected company; use Enable Application to reverse this change. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Dispatch Job **Slug:** `HOUSECALL_PRO_DISPATCH_JOB` Update the employees dispatched to a Housecall Pro job. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `job_id` | string | Yes | Housecall Pro job ID. | | `dispatched_employees` | array | Yes | Employees to dispatch to the job. Send an empty list to dispatch none. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Enable Application **Slug:** `HOUSECALL_PRO_ENABLE_APPLICATION` Enable the application for the connected company; use Disable Application to reverse this change. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Application **Slug:** `HOUSECALL_PRO_GET_APPLICATION` Get the application and its current state for the connected company. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Company **Slug:** `HOUSECALL_PRO_GET_COMPANY` Return the connected Housecall Pro company, its time zone, service area, address, and accessible child locations for company-context discovery. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Customer **Slug:** `HOUSECALL_PRO_GET_CUSTOMER` Return one Housecall Pro customer by ID, including addresses and optional attachment or do-not-service details. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `expand` | array | No | Optional customer details to include. | | `customer_id` | string | Yes | Housecall Pro customer ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get a Customer's Address **Slug:** `HOUSECALL_PRO_GET_CUSTOMER_ADDRESS` Get a customer's address via customer ID and address ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `address_id` | string | Yes | Housecall Pro customer address ID. | | `customer_id` | string | Yes | Housecall Pro customer ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Estimate **Slug:** `HOUSECALL_PRO_GET_ESTIMATE` Return one Housecall Pro estimate by ID, optionally including attachments on its estimate options. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `expand` | array | No | Set to attachments to include attachments on estimate options. | | `estimate_id` | string | Yes | Housecall Pro estimate ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Event **Slug:** `HOUSECALL_PRO_GET_EVENT` Return one Housecall Pro event by ID, including its schedule, address, tags, recurrence, and assigned employees. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `event_id` | string | Yes | Housecall Pro event ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Invoice **Slug:** `HOUSECALL_PRO_GET_INVOICE` Return one Housecall Pro invoice by UUID, including amounts, dates, line items, adjustments, payments, and its related job ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `invoice_uuid` | string | Yes | Housecall Pro invoice UUID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Job **Slug:** `HOUSECALL_PRO_GET_JOB` Return one Housecall Pro job by ID with optional attachments or appointments expanded. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `expand` | array | No | Optional job details to include. | | `job_id` | string | Yes | Housecall Pro job ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Lead **Slug:** `HOUSECALL_PRO_GET_LEAD` Return one Housecall Pro lead by ID with its customer, address, assigned employee, status, totals, and conversion records. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `lead_id` | string | Yes | Housecall Pro lead ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Price Form **Slug:** `HOUSECALL_PRO_GET_PRICE_FORM` Get one Housecall Pro price-book price form by UUID, including its pricing fields and assignments. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `uuid` | string | Yes | Housecall Pro price-form UUID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Schedule Availability **Slug:** `HOUSECALL_PRO_GET_SCHEDULE_AVAILABILITY` Return the connected Housecall Pro company's configured business-hour schedule windows and booking availability buffer. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Booking Windows **Slug:** `HOUSECALL_PRO_LIST_BOOKING_WINDOWS` Return currently available Housecall Pro booking windows for an optional date range, service, price form, duration, or employee set. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `service_id` | string | No | Price-book service ID used to filter eligible employees and derive the window duration. | | `start_date` | string | No | Start timestamp in YYYY-MM-DDTHH:MM:SS format; omit to start on the next day with an available window. | | `employee_ids` | array | No | Employee IDs whose availability should be searched. | | `price_form_id` | string | No | Price-form ID used to filter availability by assigned employees. | | `show_for_days` | integer | No | Number of schedule days to consider; Housecall Pro defaults to 7. | | `service_duration` | integer | No | Window duration in minutes; overrides the selected service's configured duration. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Checklists **Slug:** `HOUSECALL_PRO_LIST_CHECKLISTS` Get one page of checklists belonging to one or more jobs or estimates. Increment page to request another page. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | One-based result page to return. | | `per_page` | integer | No | Number of checklists to return on this page. | | `job_uuids` | array | No | Job UUIDs whose checklists should be returned. Provide this or estimate_uuids. | | `estimate_uuids` | array | No | Estimate UUIDs whose checklists should be returned. Provide this or job_uuids. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Customer Addresses **Slug:** `HOUSECALL_PRO_LIST_CUSTOMER_ADDRESSES` Return one page of service and billing addresses for a Housecall Pro customer, including address IDs used by job and estimate tools. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Continuation cursor from a previous response; omit for the first page. | | `sort_by` | string ("created_at" | "updated_at") | No | Address attribute used to sort results. | | `page_size` | integer | No | Number of addresses to return on this page. | | `customer_id` | string | Yes | Housecall Pro customer ID. | | `sort_direction` | string ("asc" | "desc") | No | Sort addresses in descending or ascending order. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Customers **Slug:** `HOUSECALL_PRO_LIST_CUSTOMERS` Search and return one page of customers by name, email, phone number, or address. Pass the returned cursor to retrieve the next page. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | No | Search customers by name, email, mobile number, or address. | | `cursor` | string | No | Continuation cursor from a previous response; omit for the first page. | | `expand` | array | No | Optional customer details to include. | | `sort_by` | string | No | Customer attribute used to sort results. | | `page_size` | integer | No | Maximum customers to return on this page. | | `location_ids` | array | No | Company location IDs whose customers should be returned. | | `sort_direction` | string ("asc" | "desc") | No | Sort results in ascending or descending order. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Employees **Slug:** `HOUSECALL_PRO_LIST_EMPLOYEES` Page through active employees for assignment and scheduling decisions. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Continuation cursor from a previous response; omit for the first page. | | `sort_by` | string | No | Employee attribute used to sort results. | | `page_size` | integer | No | Maximum employees to return on this page. | | `location_ids` | array | No | Company location IDs whose employees should be returned. | | `sort_direction` | string ("asc" | "desc") | No | Sort results in ascending or descending order. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Estimate Option Line Items **Slug:** `HOUSECALL_PRO_LIST_ESTIMATE_OPTION_LINE_ITEMS` Return one page of pricing line items for an estimate option. Pass the returned cursor to retrieve the next page. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Continuation cursor from a previous response; omit for the first page. | | `option_id` | string | Yes | Estimate option ID. | | `page_size` | integer | No | Maximum line items to return on this page. | | `estimate_id` | string | Yes | Housecall Pro estimate ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Estimates **Slug:** `HOUSECALL_PRO_LIST_ESTIMATES` Filter and return one page of estimates by schedule, employee, customer, work status, location, and sort order. Pass the returned cursor to retrieve the next page. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Continuation cursor from a previous response; omit for the first page. | | `expand` | array | No | Optional estimate details to include. | | `sort_by` | string ("created_at" | "updated_at" | "id") | No | Estimate attribute used to sort results. | | `page_size` | integer | No | Maximum estimates to return on this page. | | `customer_id` | string | No | Return estimates for this Housecall Pro customer ID. | | `work_status` | array | No | Work statuses to include; omit to include all statuses. | | `employee_ids` | array | No | Employee IDs assigned to returned estimates. | | `location_ids` | array | No | Company location IDs whose estimates should be returned. | | `sort_direction` | string ("asc" | "desc") | No | Sort results in ascending or descending order. | | `scheduled_end_max` | string | No | Latest scheduled end timestamp, inclusive, in ISO 8601 format. | | `scheduled_end_min` | string | No | Earliest scheduled end timestamp, inclusive, in ISO 8601 format. | | `scheduled_start_max` | string | No | Latest scheduled start timestamp, inclusive, in ISO 8601 format. | | `scheduled_start_min` | string | No | Earliest scheduled start timestamp, inclusive, in ISO 8601 format. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Events **Slug:** `HOUSECALL_PRO_LIST_EVENTS` Filter and return one page of company events. Pass the returned cursor to retrieve the next page. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Continuation cursor from a previous response; omit for the first page. | | `sort_by` | string ("name" | "note" | "created_at" | "updated_at" | "street" | "street_line_2" | "city" | "state" | "zip") | No | Event attribute used to sort results. | | `page_size` | integer | No | Maximum events to return on this page. | | `location_ids` | array | No | Company location IDs whose events should be returned. | | `sort_direction` | string ("asc" | "desc") | No | Sort results in ascending or descending order. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Invoices **Slug:** `HOUSECALL_PRO_LIST_INVOICES` Filter and return one page of invoices by location, status, customer, dates, amount due, payment method, and sort order. Pass the returned cursor to retrieve the next page. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Continuation cursor from a previous response; omit for the first page. | | `sort_by` | string ("amount" | "created_at" | "due_amount" | "due_at" | "invoice_number" | "paid_at" | "sent_at" | "status" | "updated_at") | No | Invoice attribute used to sort results. | | `statuses` | array | No | Invoice statuses to include. | | `page_size` | integer | No | Maximum invoices to return on this page. | | `due_at_max` | string | No | Latest invoice due timestamp, inclusive, in ISO 8601 format. | | `due_at_min` | string | No | Earliest invoice due timestamp, inclusive, in ISO 8601 format. | | `paid_at_max` | string | No | Latest invoice payment timestamp, inclusive, in ISO 8601 format. | | `paid_at_min` | string | No | Earliest invoice payment timestamp, inclusive, in ISO 8601 format. | | `location_ids` | array | No | Company location IDs whose invoices should be returned. | | `amount_due_max` | number | No | Maximum amount due, inclusive. | | `amount_due_min` | number | No | Minimum amount due, inclusive. | | `created_at_max` | string | No | Latest invoice creation timestamp, inclusive, in ISO 8601 format. | | `created_at_min` | string | No | Earliest invoice creation timestamp, inclusive, in ISO 8601 format. | | `customer_uuids` | array | No | Customer UUIDs whose invoices should be returned. | | `sort_direction` | string ("asc" | "desc") | No | Sort results in ascending or descending order. | | `payment_methods` | array | No | Payment methods to include. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Job Appointments **Slug:** `HOUSECALL_PRO_LIST_JOB_APPOINTMENTS` Return the scheduled appointments and assigned employees for one job. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `job_id` | string | Yes | Housecall Pro job ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Job Input Materials **Slug:** `HOUSECALL_PRO_LIST_JOB_INPUT_MATERIALS` List all input materials recorded for one Housecall Pro job. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `job_id` | string | Yes | Housecall Pro job ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Job Invoices **Slug:** `HOUSECALL_PRO_LIST_JOB_INVOICES` Return all invoices associated with one Housecall Pro job. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `job_id` | string | Yes | Housecall Pro job ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Job Line Items **Slug:** `HOUSECALL_PRO_LIST_JOB_LINE_ITEMS` Return all line items and pricing details for one Housecall Pro job. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `job_id` | string | Yes | Housecall Pro job ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Jobs **Slug:** `HOUSECALL_PRO_LIST_JOBS` Filter and return one page of jobs by schedule, employee, customer, work status, location, and sort order. Pass the returned cursor to retrieve the next page. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Continuation cursor from a previous response; omit for the first page. | | `expand` | array | No | Optional job details to include. | | `sort_by` | string ("created_at" | "updated_at" | "invoice_number" | "id" | "description" | "work_status") | No | Job attribute used to sort results. | | `page_size` | integer | No | Maximum jobs to return on this page. | | `customer_id` | string | No | Return jobs for this Housecall Pro customer ID. | | `work_status` | array | No | Work statuses to include; omit to include all statuses. | | `employee_ids` | array | No | Employee IDs assigned to returned jobs. | | `location_ids` | array | No | Company location IDs whose jobs should be returned. | | `sort_direction` | string ("asc" | "desc") | No | Sort results in ascending or descending order. | | `scheduled_end_max` | string | No | Latest scheduled end timestamp, inclusive, in ISO 8601 format. | | `scheduled_end_min` | string | No | Earliest scheduled end timestamp, inclusive, in ISO 8601 format. | | `scheduled_start_max` | string | No | Latest scheduled start timestamp, inclusive, in ISO 8601 format. | | `scheduled_start_min` | string | No | Earliest scheduled start timestamp, inclusive, in ISO 8601 format. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Job Types **Slug:** `HOUSECALL_PRO_LIST_JOB_TYPES` Return one page of job types, optionally filtered by name, for job and estimate classification. Pass the returned cursor to retrieve the next page. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | Filter job types by name. | | `cursor` | string | No | Continuation cursor from a previous response; omit for the first page. | | `page_size` | integer | No | Maximum job types to return on this page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Lead Line Items **Slug:** `HOUSECALL_PRO_LIST_LEAD_LINE_ITEMS` Return one page of pricing line items for a lead. Pass the returned cursor to retrieve the next page. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Continuation cursor from a previous response; omit for the first page. | | `lead_id` | string | Yes | Housecall Pro lead ID. | | `page_size` | integer | No | Maximum line items to return on this page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Leads **Slug:** `HOUSECALL_PRO_LIST_LEADS` Filter and return one page of leads by employee, customer, status, tags, source, location, and sort order. Pass the returned cursor to retrieve the next page. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Continuation cursor from a previous response; omit for the first page. | | `status` | string ("lost" | "open" | "won") | No | Lead status to return. | | `sort_by` | string ("created_at" | "updated_at" | "id" | "status") | No | Lead attribute used to sort results. | | `tag_ids` | array | No | Tag IDs used to filter leads. | | `page_size` | integer | No | Maximum leads to return on this page. | | `customer_id` | string | No | Return leads for this Housecall Pro customer ID. | | `employee_ids` | array | No | Assigned employee IDs used to filter leads. | | `lead_sources` | array | No | Lead source names used to filter leads. | | `location_ids` | array | No | Company location IDs whose leads should be returned. | | `sort_direction` | string ("asc" | "desc") | No | Sort results in ascending or descending order. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Lead Sources **Slug:** `HOUSECALL_PRO_LIST_LEAD_SOURCES` Search and return one page of lead sources available for attribution, including whether each source is editable. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | No | Search lead sources by name. | | `cursor` | string | No | Continuation cursor from a previous response; omit for the first page. | | `page_size` | integer | No | Maximum lead sources to return on this page. | | `sort_direction` | string ("asc" | "desc") | No | Sort results in ascending or descending order. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Material Categories **Slug:** `HOUSECALL_PRO_LIST_MATERIAL_CATEGORIES` Page through root-level price-book material categories or categories under a selected parent. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Continuation cursor from a previous response; omit for the first page. | | `sort_by` | string ("name" | "updated_at" | "created_at") | No | Material-category attribute used to sort results. | | `page_size` | integer | No | Maximum material categories to return on this page. | | `parent_uuid` | string | No | Parent material-category UUID whose child categories should be returned; omit to return root-level categories. | | `sort_direction` | string ("asc" | "desc") | No | Sort results in ascending or descending order. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Materials **Slug:** `HOUSECALL_PRO_LIST_MATERIALS` Page through price-book materials under a material category. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Continuation cursor from a previous response; omit for the first page. | | `sort_by` | string ("name" | "updated_at" | "created_at") | No | Material attribute used to sort results. | | `page_size` | integer | No | Maximum materials to return on this page. | | `sort_direction` | string ("asc" | "desc") | No | Sort results in ascending or descending order. | | `material_category_uuid` | string | Yes | UUID of the material category whose materials should be returned. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Pipeline Statuses **Slug:** `HOUSECALL_PRO_LIST_PIPELINE_STATUSES` Return one page of configured pipeline statuses for leads, jobs, or estimates. Organizations without pipeline enabled return an empty status list. Pass the returned cursor to retrieve the next page. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Continuation cursor from a previous response; omit for the first page. | | `page_size` | integer | No | Maximum statuses to return on this page. | | `resource_type` | string ("lead" | "job" | "estimate") | Yes | Resource whose configured pipeline statuses should be returned. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Price Book Services **Slug:** `HOUSECALL_PRO_LIST_PRICE_BOOK_SERVICES` Search and page through price-book services used for job pricing and service-specific booking availability. Reuse the same filters with a cursor. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | No | Search services by name, description, or task number. | | `cursor` | string | No | Continuation cursor from a previous response. When continuing a filtered search, pass the same filters again. | | `expand` | array | No | Related service collections to populate in each result. | | `filters` | array | No | One Housecall Pro deep-object filter with a property, eq operator, and one or more grouped values. Make separate calls for additional criteria. | | `sort_by` | string | No | Service attribute used to sort results. | | `page_size` | integer | No | Maximum services to return on this page. | | `sort_direction` | string ("asc" | "desc") | No | Sort results in ascending or descending order. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Price Forms **Slug:** `HOUSECALL_PRO_LIST_PRICE_FORMS` Page through active price-book price forms and their pricing fields. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Continuation cursor from a previous response; omit for the first page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Routes **Slug:** `HOUSECALL_PRO_LIST_ROUTES` Return one page of company routes for a date, including grouped employees, job appointments, events, and estimates. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `date` | string | No | Route date in YYYY-MM-DD format; omit to use today's date. | | `cursor` | string | No | Continuation cursor from a previous response; omit for the first page. | | `page_size` | integer | No | Maximum routes to return on this page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Service Zones **Slug:** `HOUSECALL_PRO_LIST_SERVICE_ZONES` Page through service zones, optionally filtering by ZIP code or address, for customer intake and serviceability checks. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Continuation cursor from a previous response; omit for the first page. | | `address` | string | No | Address used to filter service zones. | | `zip_code` | string | No | ZIP code used to filter service zones. | | `page_size` | integer | No | Maximum service zones to return on this page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Tags **Slug:** `HOUSECALL_PRO_LIST_TAGS` Page through the company's reusable tags for customer, job, and lead classification. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Continuation cursor from a previous response; omit for the first page. | | `sort_by` | string ("created_at" | "name") | No | Tag attribute used to sort results. | | `page_size` | integer | No | Maximum tags to return on this page. | | `sort_direction` | string ("asc" | "desc") | No | Sort results in ascending or descending order. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Lock Job **Slug:** `HOUSECALL_PRO_LOCK_JOB` Irreversibly lock a Housecall Pro job by ID and return the locked job. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `job_id` | string | Yes | Housecall Pro job ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Preview Invoice by UUID **Slug:** `HOUSECALL_PRO_PREVIEW_INVOICE` Preview a specific Housecall Pro invoice by UUID as an HTML file. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `invoice_uuid` | string | Yes | Housecall Pro invoice UUID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Customer **Slug:** `HOUSECALL_PRO_UPDATE_CUSTOMER` Update editable contact, notification, tag, lead-source, or note fields on an existing Housecall Pro customer. Provide at least one field to change. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tags` | array | No | Complete replacement list of customer tag names. | | `email` | string | No | Replacement email address. | | `notes` | string | No | Replacement customer notes. | | `company` | string | No | Replacement company name. | | `last_name` | string | No | Replacement last name. | | `first_name` | string | No | Replacement first name. | | `customer_id` | string | Yes | Housecall Pro customer ID. | | `home_number` | string | No | Replacement home number. | | `lead_source` | string | No | Replacement lead source name. | | `work_number` | string | No | Replacement work number. | | `mobile_number` | string | No | Replacement mobile number. | | `notifications_enabled` | boolean | No | Whether the customer receives notifications. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Estimate Option Schedule **Slug:** `HOUSECALL_PRO_UPDATE_ESTIMATE_OPTION_SCHEDULE` Replace the schedule, notification settings, and assigned employees for a Housecall Pro estimate option. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `expand` | array | No | Related resources to include in the response. | | `notify` | boolean | No | Whether to notify the customer of the schedule update. | | `end_time` | string | No | Scheduled end time as an ISO 8601 timestamp. | | `option_id` | string | Yes | Housecall Pro estimate option ID. | | `notify_pro` | boolean | No | Whether to notify assigned employees of the schedule update. | | `start_time` | string | Yes | Scheduled start time as an ISO 8601 timestamp. | | `estimate_id` | string | Yes | Housecall Pro estimate ID. | | `dispatched_employees` | array | No | Employees to assign to the estimate option. | | `arrival_window_in_minutes` | number | No | Arrival-window duration in minutes. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Franchise Info **Slug:** `HOUSECALL_PRO_UPDATE_FRANCHISE_INFO` Update territory-management, franchisee-identifier, or custom external metadata for the connected Housecall Pro company. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `metadata` | object | No | Franchise metadata fields to update. Provide at least one nested field. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Appointment **Slug:** `HOUSECALL_PRO_UPDATE_JOB_APPOINTMENT` Replace the schedule and assigned employees for an existing Housecall Pro job appointment. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `job_id` | string | Yes | Housecall Pro job ID. | | `end_time` | string | Yes | Appointment end time as an ISO 8601 timestamp. | | `start_time` | string | Yes | Appointment start time as an ISO 8601 timestamp. | | `appointment_id` | string | Yes | Housecall Pro appointment ID. | | `arrival_window_minutes` | integer | No | Arrival-window duration in minutes. | | `dispatched_employees_ids` | array | Yes | Housecall Pro employee IDs assigned to the appointment. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update a Job Line Item **Slug:** `HOUSECALL_PRO_UPDATE_JOB_LINE_ITEM` Update one existing line item on a Housecall Pro job. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Housecall Pro line-item ID. | | `kind` | string ("materials" | "labor" | "fixed gratuity" | "fixed discount" | "percent discount") | No | Updated pricing behavior of the line item. | | `name` | string | Yes | Updated line-item name. | | `job_id` | string | Yes | Housecall Pro job ID. | | `taxable` | boolean | No | Whether tax applies to the line item. | | `quantity` | number | No | Updated number of units in the line item. | | `unit_cost` | number | No | Updated direct cost for one unit, in cents. | | `unit_price` | number | No | Updated selling price for one unit, in cents. | | `description` | string | No | Updated customer-facing line-item description. | | `service_item_id` | string | No | Related service or price-book item ID. | | `service_item_type` | string ("market_place" | "organizational" | "pricebook_material") | No | Source catalog type of the related service item. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Job Schedule **Slug:** `HOUSECALL_PRO_UPDATE_JOB_SCHEDULE` Update the supplied schedule, notification, or dispatched-employee fields on a Housecall Pro job. Jobs with multiple appointments must use the appointment actions instead. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `expand` | array | No | Related resources to include in the response. | | `job_id` | string | Yes | Housecall Pro job ID. | | `notify` | boolean | No | Whether to notify the customer of the schedule update. | | `end_time` | string | No | Job end time as an ISO 8601 timestamp. | | `notify_pro` | boolean | No | Whether to notify assigned employees of the schedule update. | | `start_time` | string | Yes | Job start time as an ISO 8601 timestamp. | | `dispatched_employees` | array | No | Employees to assign to the job. | | `arrival_window_in_minutes` | number | No | Arrival-window duration in minutes. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update a Job Type **Slug:** `HOUSECALL_PRO_UPDATE_JOB_TYPE` Update the name of a job type used to classify jobs and estimates. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Updated job-type name. | | `job_type_id` | string | Yes | Housecall Pro job-type ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Lead Source **Slug:** `HOUSECALL_PRO_UPDATE_LEAD_SOURCE` Update the name of a Housecall Pro lead source marked as editable. Account system sources may be read-only. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Updated lead-source name. | | `lead_source_id` | string | Yes | Housecall Pro lead-source ID. Use LIST_LEAD_SOURCES to find editable sources. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Material **Slug:** `HOUSECALL_PRO_UPDATE_MATERIAL` Update information for an existing Housecall Pro price-book material. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cost` | integer | No | Updated material cost, in cents. | | `name` | string | No | Updated material name. | | `uuid` | string | Yes | UUID of the material to update. | | `price` | integer | No | Updated material price, in cents. | | `taxable` | boolean | No | Whether the material is taxable on an invoice. | | `description` | string | No | Updated material description. | | `part_number` | string | No | Updated material part number. | | `unit_of_measure` | string | No | Updated unit used to measure the material. | | `flat_rate_enabled` | boolean | No | Whether flat-rate pricing is enabled for the material. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Material Category **Slug:** `HOUSECALL_PRO_UPDATE_MATERIAL_CATEGORY` Update the name of an existing price-book material category. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Updated material-category name. | | `uuid` | string | Yes | UUID of the material category to update. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Pipeline Status **Slug:** `HOUSECALL_PRO_UPDATE_PIPELINE_STATUS` Irreversibly move a Housecall Pro lead, job, or estimate to a pipeline status with an equal or higher order value. Pipeline statuses cannot be moved backward with this action. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `status_id` | string | Yes | Target Housecall Pro pipeline status ID. | | `resource_id` | string | Yes | Housecall Pro lead, job, or estimate ID to update. | | `resource_type` | string ("lead" | "job" | "estimate") | Yes | Type of Housecall Pro resource whose pipeline status should be updated. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Price Form **Slug:** `HOUSECALL_PRO_UPDATE_PRICE_FORM` Update settings, assignments, and nested pricing fields on an existing Housecall Pro price form. Provide at least one field to change. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | Updated price-form name. | | `uuid` | string | Yes | UUID of the price form to update. | | `image` | string | No | Updated price-form image value. | | `taxable` | boolean | No | Whether prices calculated by this form are taxable. | | `assigned` | object | No | Professionals and tags assigned to the price form. | | `question_1` | string | No | Updated first question shown with the price form. | | `question_2` | string | No | Updated second question shown with the price form. | | `bookable_as` | string | No | Updated online-booking classification. | | `description` | string | No | Updated description. | | `olb_enabled` | boolean | No | Whether the price form is enabled for online booking. | | `fields_attributes` | array | No | Complete pricing-field attributes to update on the form. | | `duration_in_minutes` | integer | No | Updated default service duration in minutes. | | `default_service_zone_id` | string | No | Updated default Housecall Pro service-zone ID. | | `dynamic_duration_enabled` | boolean | No | Whether selected fields and options dynamically determine duration. | | `automatically_add_to_new_job` | boolean | No | Whether to add this price form automatically to new jobs. | | `service_area_pricing_enabled` | boolean | No | Whether pricing varies by service area. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Schedule Availability **Slug:** `HOUSECALL_PRO_UPDATE_SCHEDULE_AVAILABILITY` Replace the connected Housecall Pro company's daily business-hours windows and minimum booking buffer. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `daily_schedule_windows` | array | Yes | Complete daily business-hours schedule to store for the company. | | `availability_buffer_in_days` | number | Yes | Minimum number of days before an available time can be booked. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update a Tag **Slug:** `HOUSECALL_PRO_UPDATE_TAG` Update the name of an existing reusable tag. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Replacement name for the reusable tag. | | `tag_id` | string | Yes | Housecall Pro tag ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not |