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 for the "Customer" resource allows users to modify existing customer attributes such as name, email, company, phone numbers, and notification preferences.

Common scenarios where this node is beneficial include:

  • Keeping customer records up-to-date after receiving new contact details.
  • Correcting errors or typos in customer data.
  • Changing notification settings for individual customers.

For example, a user could update a customer's email address and mobile number after they provide new contact info, ensuring communications are sent correctly.

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 by 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 return an 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 missing, authentication will fail. Check credential configuration.
  • Network Issues: Connectivity problems can cause request failures. Confirm network access to the Housecall Pro API endpoint.
  • Field Validation Errors: Providing invalid formats (e.g., malformed email) may cause the API to reject the update. Validate input data before sending.

Links and References

Discussion