Magnet Customer icon

Magnet Customer

Consume Magnet Customer API

Actions104

Deal → Update

AI-generated

Overview

This node updates an existing deal in the Magnet Customer system. It is useful for scenarios where you need to modify details of a deal such as its title, description, associated organization or contact, pipeline stage, expected close date, status, assigned user, amount, and custom fields. For example, you can update the status of a deal to 'won' after closing a sale or change the associated contact if the deal is transferred to a different client.

Use Case Examples

  1. Updating the title and description of a deal to reflect new information.
  2. Changing the pipeline stage of a deal to indicate progress in the sales process.
  3. Associating a deal with a different organization or contact.
  4. Setting custom fields on a deal to capture additional data specific to your business needs.

Properties

Name Meaning
Authentication Method of authentication to use for the API request (API Token or OAuth2).
Deal ID The unique identifier of the deal to update.
Title The new title of the deal.
Description The new description of the deal.
Associate With Type of entity (Organization or Contact) to link the deal with.
Organization ID ID of the organization to associate with the deal (if 'Associate With' is Organization).
Contact ID ID of the contact to associate with the deal (if 'Associate With' is Contact).
Pipeline Name or ID ID of the pipeline where the deal will be placed. If omitted, defaults to the first stage of the default pipeline.
Stage Name or ID ID of the stage within the pipeline where the deal will be placed. If omitted, defaults to the first stage of the default pipeline.
Expectation of Closing Expected closing date and time for the deal.
Status Current status of the deal (Open, Won, Lost, Deleted). Defaults to Open if not provided.
User Name or ID ID of the user to whom the deal activity will be assigned. Defaults to the authorized user if omitted.
Amount Monetary value of the deal. Defaults to 0 if not set.
Custom Fields Custom fields to set on the deal, allowing additional data not predefined in the node.
Encode Custom Fields If true, custom fields are automatically encoded from their actual names/values to IDs as required by the API.

Output

JSON

  • _id - Unique identifier of the updated deal.
  • title - Title of the updated deal.
  • description - Description of the updated deal.
  • associateWith - Type of entity associated with the deal (organization or contact).
  • organization - ID of the associated organization, if applicable.
  • contact - ID of the associated contact, if applicable.
  • pipeline - ID of the pipeline where the deal is placed.
  • stage - ID of the stage within the pipeline where the deal is placed.
  • expectedCloseDate - Expected closing date of the deal.
  • status - Current status of the deal.
  • staff - ID of the user assigned to the deal activity.
  • amount - Monetary value of the deal.
  • customFields - Custom fields set on the deal.

Dependencies

  • Magnet Customer API

Troubleshooting

  • Ensure the Deal ID provided is valid and exists in the Magnet Customer system to avoid 'deal not found' errors.
  • Verify that the authentication method (API Token or OAuth2) is correctly configured and the credentials are valid to prevent authentication failures.
  • If custom fields are used, ensure they are correctly encoded or use the 'Encode Custom Fields' option to avoid data format errors.
  • Check that the pipeline and stage IDs are valid and correspond to existing pipeline stages to prevent placement errors.

Links

Discussion