Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Addressbook → Post Undefined

AI-generated

Overview

This node integrates with the Halo PSA API, allowing users to perform various operations on different resources within the Halo PSA system. Specifically for the Addressbook resource and the Post Undefined operation, it sends a JSON payload to create or update contact group contacts in the address book.

Typical use cases include automating the management of contact groups by programmatically adding or modifying contacts within an organization's address book. For example, a user might use this node to bulk import contacts into a specific contact group or update existing group memberships based on data from other systems.

Properties

Name Meaning
Body A JSON object representing the request body to be sent to the API. It typically contains a contactgroupcontacts array with one or more contact group contact objects. The default structure is:
json { "contactgroupcontacts": [ {} ] }

Output

The node outputs an array of JSON objects corresponding to each input item processed. Each output item contains:

  • json: The parsed JSON response returned by the Halo PSA API after performing the requested operation.
  • If an error occurs and the node is configured to continue on failure, the output will contain an error field with the error message.

No binary data output is produced by this operation.

Dependencies

  • Requires valid credentials for the Halo PSA API, including:

    • Base URL of the Halo PSA instance
    • Tenant identifier
    • Client ID
    • Client Secret

  • These credentials must be configured in n8n prior to using the node.

  • The node uses HTTP requests with appropriate headers to authenticate and communicate with the Halo PSA API.

Troubleshooting

  • No credentials returned!
    This error indicates that the required API credentials are missing or not properly configured in n8n. Ensure that the API key credential is set up correctly.

  • Resource or Operation not found
    Occurs if the specified resource or operation does not exist in the node's configuration. Verify that the resource is set to "Addressbook" and the operation to "Post Undefined" as expected.

  • JSON parsing errors
    Since the Body property expects a JSON string, invalid JSON syntax will cause parsing failures. Validate the JSON format before running the node.

  • API request failures
    Errors returned from the Halo PSA API (e.g., authentication errors, validation errors) will be surfaced in the node output. Check the error messages for details and verify API permissions and request payload correctness.

Links and References

Discussion