HostBill icon

HostBill

Consume HostBill API (v.0.1.3)

Actions39

Overview

This node updates an existing client contact in the HostBill system. It is designed for scenarios where you need to modify details of a contact associated with a client, such as updating their name, address, company information, or adjusting their privileges (e.g., billing or support permissions). This is useful in automated workflows for customer management, onboarding, or when synchronizing contact data between systems.

Example use cases:

  • Automatically update a client's contact information when changes are made in another system.
  • Adjust contact privileges based on workflow logic (e.g., grant billing access after payment).
  • Batch-update multiple contacts' addresses or permissions.

Properties

Name Type Meaning
Contact ID Number The unique identifier of the contact to update. Required.
Additional Fields Collection A set of optional fields to update, such as first/last name, company, address, etc.
  First name String The contact's first name.
  Last name String The contact's last name.
  Company Name String Company name for organization-type contacts.
  Address Line 1 String First line of the contact's address.
  Address Line 2 String Second line of the contact's address.
  City String City of the contact's address.
  State String State or region of the contact's address.
  Post Code String Postal code of the contact's address.
  Country String Country of the contact's address.
  Phone Number String Contact's phone number.
Privileges Collection Set of boolean flags controlling what the contact can do (billing, support, misc actions)
  Billing: Receive billing notifications Boolean Whether the contact receives billing emails.
  Billing: Allow to view/pay invoices Boolean Whether the contact can view and pay invoices.
  Billing: Place new orders Boolean Whether the contact can place new orders.
  Billing: View current balance Boolean Whether the contact can view the account balance.
  Billing: Add funds Boolean Whether the contact can add funds.
  Billing: Creditcard Boolean Whether the contact can manage credit cards.
  Support: Open new tickets Boolean Whether the contact can open support tickets.
  Support: View current tickets Boolean Whether the contact can view support tickets.
  Support: Close tickets Boolean Whether the contact can close support tickets.
  Support: Receive email notifications Boolean Whether the contact receives support-related emails.
  Misc: Modify main profile details Boolean Whether the contact can edit main profile details.
  Misc: View emails history Boolean Whether the contact can view email history.
  Misc: Edit security settings Boolean Whether the contact can edit security settings.
  Misc: Add / Edit contacts Boolean Whether the contact can add or edit other contacts.
  Misc: Access affiliates section Boolean Whether the contact can access the affiliates section.

Output

The node returns a JSON object (or array of objects if processing multiple items), representing the updated contact. The structure typically includes the updated fields and any response data from the HostBill API. If an error occurs and "Continue On Fail" is enabled, the output will include an error field with the error message.

Example output:

[
  {
    "id": 123,
    "firstname": "John",
    "lastname": "Doe",
    "companyname": "Acme Corp",
    "address1": "123 Main St",
    "city": "Metropolis",
    "privileges": {
      "billing_emails": true,
      "support_newticket": false
    }
    // ...other updated fields
  }
]

If an error occurs:

[
  {
    "error": "Contact not found"
  }
]

Dependencies

  • HostBill API: Requires valid HostBill API credentials configured in n8n under the credential type hostBillApi.
  • n8n Configuration: No additional environment variables required beyond standard credential setup.

Troubleshooting

Common issues:

  • Invalid Contact ID: If the provided Contact ID does not exist, the node will throw an error like "Contact not found".
  • Missing Required Fields: If required properties (such as Contact ID) are missing, the node will fail with a validation error.
  • API Authentication Errors: Invalid or expired API credentials will result in authentication errors.
  • Insufficient Permissions: The API user may lack permission to update contacts, resulting in authorization errors.

How to resolve:

  • Double-check that the Contact ID exists in HostBill.
  • Ensure all required fields are filled.
  • Verify that your API credentials are correct and have sufficient permissions.
  • Check the HostBill API documentation for required permissions and field formats.

Links and References

Discussion