ConnectWise Manage icon

ConnectWise Manage

Consume ConnectWise Manage API

Overview

This node integrates with the ConnectWise Manage API to perform operations on various resources, including agreements. Specifically, for the Agreement resource, it supports deleting an existing agreement by its ID.

A common use case for this node is automating the management of agreements within ConnectWise Manage, such as removing outdated or invalid agreements programmatically as part of a workflow. For example, when a contract expires or is terminated, this node can be used to delete the corresponding agreement record automatically.

Properties

Name Meaning
Agreement ID The unique identifier of the agreement to delete. This is a required string input.

Output

  • The output JSON contains the response from the ConnectWise Manage API after attempting to delete the specified agreement.
  • Typically, a successful delete operation returns an empty object or confirmation of deletion.
  • No binary data output is produced by this operation.

Example output JSON (successful deletion might be an empty object):

{}

Dependencies

  • Requires an active connection to the ConnectWise Manage API.
  • The node must be configured with valid API credentials (an API key or authentication token) that have permission to delete agreements.
  • The base URL of the ConnectWise Manage instance (siteUrl) must be set in the credentials.

Troubleshooting

  • Common issues:

    • Invalid or missing Agreement ID: The node requires a valid agreement ID; ensure this is provided and correct.
    • Insufficient permissions: The API credentials must have rights to delete agreements.
    • Network or authentication errors: Verify API credentials and network connectivity to the ConnectWise Manage instance.
  • Error messages:

    • "Operation 'delete' is not supported for resource 'agreement'": This would indicate a misconfiguration or unsupported operation; however, the code confirms delete is supported for agreement.
    • API request failures will throw errors with messages from the ConnectWise Manage API, which may include HTTP status codes and error details.
    • If the agreement ID does not exist, the API may return a 404 error indicating the resource was not found.
  • Resolution tips:

    • Double-check the Agreement ID value.
    • Confirm API credentials and permissions.
    • Review API endpoint accessibility and network settings.

Links and References


This summary is based solely on static analysis of the provided source code and property definitions.

Discussion