Magnet Customer icon

Magnet Customer

Consume Magnet Customer API

Pipeline → Update

AI-generated

Overview

This node updates an existing pipeline in the Magnet Customer system. 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. This operation is useful for managing sales or project pipelines dynamically, ensuring that the pipeline structure and metadata reflect current business needs.

Use Case Examples

  1. Updating the title of a sales pipeline to reflect a new campaign.
  2. Setting a specific pipeline as the default view for users.
  3. Adding or removing roles and staff members associated with a pipeline to control access and responsibilities.
  4. Defining or modifying stages within a pipeline, including setting probabilities, order, and status flags like 'won' or 'lost' stages.

Properties

Name Meaning
Authentication Method of authentication to use for the API request, either API Token or OAuth2.
Pipeline ID The unique identifier of the pipeline to update.
Update Fields Collection of fields to update on the pipeline, including title, default view status, associated roles, staff members, and stages.

Output

JSON

  • _id - Unique identifier of the updated pipeline.
  • title - Title of the updated pipeline.
  • defaultView - Boolean indicating if the pipeline is the default view.
  • roles - Array of roles associated with the pipeline.
  • staffs - Array of staff members associated with the pipeline.
  • stages - Array of stages defined within the pipeline, each with details such as name, probability, position, active status, and won/lost flags.

Dependencies

  • Magnet Customer API

Troubleshooting

  • Ensure the Pipeline ID provided is correct and exists in the Magnet Customer system to avoid 'not found' errors.
  • Verify that the authentication method and credentials (API Token or OAuth2) are valid and have sufficient permissions to update pipelines.
  • When updating stages, ensure that the stage details are correctly formatted and all required fields (like stage name) are provided.
  • If the node fails with permission errors, check the roles and staff associations to confirm they are valid and accessible by the authenticated user.

Links

Discussion