Magnet Customer icon

Magnet Customer

Consume Magnet Customer API

Actions68

Overview

This node integrates with the Magnet Customer API to update an existing sales pipeline. It allows users to modify various attributes of a pipeline such as its title, default view status, associated roles and staff members, and the stages within the pipeline.

Common scenarios where this node is beneficial include:

  • Automating updates to sales pipelines based on external triggers or data changes.
  • Synchronizing pipeline configurations across different systems.
  • Managing pipeline stages dynamically as sales processes evolve.

For example, a user could automate changing the title of a pipeline, set it as the default view, assign specific roles and staff members responsible for the pipeline, and define or reorder the stages with probabilities and statuses (won/lost).

Properties

Name Meaning
Authentication Method of authentication: "API Token" or "OAuth2".
Pipeline ID The unique identifier of the pipeline to update.
Update Fields Collection of fields to update in the pipeline:
- Title New title for the pipeline.
- Default View Boolean indicating if this pipeline should be the default view.
- Roles List of role IDs or names to associate with the pipeline.
- Staffs List of staff member IDs or names to associate with the pipeline.
- Stages Array of stage objects defining the pipeline stages, each with:
   • Name Name of the stage (required).
   • Probability (%) Probability percentage of success for the stage (0-100).
   • Position Order of the stage in the pipeline (0-based index).
   • Active Boolean indicating if the stage is active.
   • Is Won Stage? Boolean indicating if this stage represents a won deal.
   • Is Lost Stage? Boolean indicating if this stage represents a lost deal.

Output

The node outputs JSON data representing the updated pipeline object returned from the Magnet Customer API after the update operation. This JSON includes all relevant details of the pipeline reflecting the applied changes.

The node does not output binary data.

Dependencies

  • Requires access to the Magnet Customer API.
  • Requires either an API token or OAuth2 credentials configured in n8n for authentication.
  • Uses internal helper methods to make HTTP requests to the API endpoints related to pipelines.
  • The node depends on the Magnet Customer API's availability and correct configuration of permissions for updating pipelines.

Troubleshooting

  • Common Issues:

    • Invalid or missing Pipeline ID will cause the update to fail.
    • Insufficient permissions or invalid API credentials can result in authentication errors.
    • Providing invalid stage data (e.g., missing required fields like stage name) may cause validation errors.
    • Network connectivity issues may prevent successful API calls.

  • Error Messages:

    • "error": "Pipeline not found" — Verify that the Pipeline ID is correct.
    • "error": "Unauthorized" — Check that the API token or OAuth2 credentials are valid and have necessary scopes.
    • "error": "Validation failed" — Review the update fields for missing or incorrect values, especially in stages.

  • Resolution Tips:

    • Double-check the Pipeline ID input.
    • Ensure API credentials are correctly set up in n8n.
    • Validate all required fields before running the node.
    • Use the "Continue On Fail" option to handle errors gracefully during batch operations.

Links and References

Discussion