Housecall Pro

Interact with the Housecall Pro API

Actions20

Overview

This node interacts with the Housecall Pro API to update customer information. Specifically, the "Update" operation under the "Customer" resource allows users to modify attributes of an existing customer by specifying the customer's ID and the fields to update.

Common scenarios for this node include:

  • Keeping customer records up-to-date with the latest contact details.
  • Modifying notification preferences for customers.
  • Correcting or adding missing customer information such as phone numbers or company affiliation.

Practical example:
A business using Housecall Pro wants to update a customer's email address and mobile number after receiving new contact info. This node can be used in an automation workflow to perform that update seamlessly.

Properties

Name Meaning
Customer ID The unique identifier of the customer to update.
Update Fields Collection of fields to update on the customer. Options include:
- First Name: Customer's first name
- Last Name: Customer's last name
- Email: Customer's email address
- Company: Customer's company name
- Notifications Enabled: Boolean indicating if the customer should receive notifications
- Mobile Number: Customer's mobile phone number
- Home Number: Customer's home phone number
- Work Number: Customer's work phone number

Output

The node outputs JSON data representing the updated customer object returned from the Housecall Pro API. This typically includes all customer attributes after the update has been applied, reflecting the current state of the customer record.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to the Housecall Pro API.
  • Needs an API authentication token configured in n8n credentials to authorize requests.
  • The base URL for API requests is https://api.housecallpro.com.
  • Proper permissions to update customer data via the API are necessary.

Troubleshooting

  • Invalid Customer ID: If the provided Customer ID does not exist, the API will likely return a "not found" error. Verify the ID is correct.
  • Missing Required Fields: Although updating fields is optional, the Customer ID is required. Ensure it is provided.
  • API Authentication Errors: If the API key or token is invalid or expired, authentication errors will occur. Check and refresh credentials as needed.
  • Network Issues: Connectivity problems may cause request failures. Confirm network access to the Housecall Pro API endpoint.
  • Field Validation Errors: Providing invalid data types (e.g., non-boolean for notifications) may result in API validation errors. Ensure field values conform to expected types.

Links and References

Discussion