Overview
This node integrates with the Resource Guru API to manage clients and projects. Specifically, for the Client - Archive operation, it allows users to archive a client by marking it as archived in Resource Guru. Archiving a client typically means that the client is no longer active or relevant but its data is retained for historical reference.
Common scenarios where this node is beneficial include:
- Automatically archiving clients who have completed their contracts.
- Cleaning up active client lists by moving inactive clients to an archived state.
- Integrating with workflows that update client statuses based on external triggers.
Example: A company uses this node to archive clients who haven't had any activity for over a year, helping keep their active client list manageable.
Properties
| Name | Meaning |
|---|---|
| Client ID | The unique numeric identifier of the client to be archived. This is required to specify which client to archive. |
Output
The node outputs JSON data representing the updated client resource after the archive operation. This typically includes the client's details with the archived field set to true, indicating the client is now archived.
No binary data output is involved in this operation.
Dependencies
- Requires an OAuth2 API credential configured for Resource Guru with appropriate permissions.
- Needs the account ID from the credentials to construct the base URL for API requests.
- The node sends a PUT request to the Resource Guru API endpoint
/clients/{clientId}with a body{ archived: true }.
Troubleshooting
- Invalid Client ID: If the provided Client ID does not exist or is invalid, the API will likely return a 404 error. Verify the Client ID is correct.
- Authentication Errors: Missing or incorrect API credentials will cause authentication failures. Ensure the OAuth2 credential is properly set up and authorized.
- Permission Denied: Insufficient permissions in the API token may prevent archiving. Confirm the token has rights to modify client data.
- Network Issues: Connectivity problems can cause request failures. Check network access to the Resource Guru API.
- API Rate Limits: Excessive requests might trigger rate limiting. Implement retries or backoff if needed.
Links and References
- Resource Guru API Documentation (for detailed API endpoints and request formats)
- n8n OAuth2 Credential Setup Guide