Magnet Customer icon

Magnet Customer

Consume Magnet Customer API

Deal → Create

AI-generated

Overview

This node operation creates a new deal in the Magnet Customer system. It allows users to specify various details about the deal such as title, description, association with an organization or contact, pipeline and stage placement, expected closing date, status, assigned user, amount, and custom fields. This operation is useful for automating the creation of sales deals within a CRM workflow, enabling seamless integration and data management.

Use Case Examples

  1. Creating a new sales deal linked to a specific organization with a defined pipeline and stage.
  2. Automating deal creation with custom fields and assigning it to a specific staff member for follow-up.

Properties

Name Meaning
Authentication Method of authentication to use for the API request, either API Token or OAuth2.
Title The title of the deal to be created.
Description A description providing details about the deal.
Associate With Type of entity (Organization or Contact) to link the deal with.
Organization ID ID of the organization to associate the deal with (shown if 'Associate With' is Organization).
Contact ID ID of the contact to associate the deal with (shown 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. Defaults to the first stage if omitted.
Expectation of Closing Expected closing date of the deal.
Status Status of the deal, such as Open, Won, Lost, or Deleted. Defaults to Open if not provided.
User Name or ID ID of the staff 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 Additional custom fields to set on the deal, allowing for extended data beyond predefined fields.

Output

JSON

  • _id - Unique identifier of the created deal.
  • title - Title of the created deal.
  • description - Description of the created deal.
  • associateWith - Entity type the deal is associated with (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 staff user assigned to the deal activity.
  • amount - Value of the deal.
  • customFields - Custom fields set on the deal.

Dependencies

  • Magnet Customer API with either API Token or OAuth2 authentication

Troubleshooting

  • Ensure that the required fields such as title and association IDs are correctly provided to avoid validation errors.
  • If the pipeline or stage IDs are incorrect or missing, the deal may be placed in an unintended default stage or cause an error.
  • Authentication failures can occur if the API token or OAuth2 credentials are invalid or expired; verify credentials before use.

Discussion