ConnectWise Manage icon

ConnectWise Manage

Consume ConnectWise Manage API

Overview

The node integrates with the ConnectWise Manage API to perform various operations on different resources within ConnectWise Manage. Specifically, for the Agreement resource and the Update operation, this node updates an existing agreement record in ConnectWise Manage.

This is useful in scenarios where you need to programmatically modify details of an existing agreement, such as changing its type, associated company, or start/end dates, without manually updating it through the ConnectWise Manage interface.

Practical example:

  • Automatically update contract terms or dates when a customer renews or modifies their service agreement.
  • Sync agreement data from another system into ConnectWise Manage by updating agreements based on external triggers.

Properties

Name Meaning
Agreement ID The unique identifier of the agreement to update (required).
Additional Fields Optional fields to update on the agreement:
- Type The type of agreement. Options: Standard, Support.
- Company ID The ID of the company associated with this agreement.
- Start Date The start date of the agreement in YYYY-MM-DD format.
- End Date The end date of the agreement in YYYY-MM-DD format.

Output

The output is a JSON object representing the updated agreement as returned by the ConnectWise Manage API. It contains all the fields of the agreement after the update operation.

  • Each item corresponds to one input item processed.
  • If multiple items are processed, the output is an array of such JSON objects.
  • No binary data is produced by this operation.

Dependencies

  • Requires an active connection to the ConnectWise Manage API.
  • Requires configuration of an API authentication credential (e.g., API key or token) for ConnectWise Manage within n8n.
  • The node uses the base URL configured in the credentials to make REST API calls to ConnectWise Manage's v4_6_release API.

Troubleshooting

  • Error: Operation 'update' is not supported for resource 'agreement'
    This indicates a misconfiguration or unsupported operation/resource combination. Verify that the resource is set to "agreement" and operation to "update".

  • Missing Agreement ID
    The update operation requires the Agreement ID to identify which agreement to update. Ensure this property is provided and valid.

  • API Request Failures
    Errors from the ConnectWise Manage API (e.g., authentication errors, invalid data) will be surfaced. Check the error message for details. Common fixes include verifying API credentials, ensuring required fields are present, and validating field formats (e.g., date strings).

  • Partial Updates Not Applied
    Only fields included in "Additional Fields" are updated. If a field is omitted, it remains unchanged. Make sure to specify all fields you want to update.

  • Date Format Issues
    Dates must be in YYYY-MM-DD format. Invalid date formats may cause API errors.

Links and References

Discussion