Magnet Customer icon

Magnet Customer

Consume Magnet Customer API

Actions104

Prospect → Update

AI-generated

Overview

This node updates an existing prospect's information in the Magnet Customer system. It is useful for scenarios where you need to modify details of a prospect such as contact information, address, custom fields, and other personal or business-related data. For example, you can update a prospect's email, phone numbers, gender, birthdate, work, marital status, legal type, and custom fields programmatically within an automation workflow.

Use Case Examples

  1. Updating a prospect's email and phone number after receiving new contact information.
  2. Modifying a prospect's address and adding custom fields for additional data tracking.

Properties

Name Meaning
Authentication Selects the authentication method to use for the API request (API Token or OAuth2).
Contact ID The unique identifier of the prospect to update. This is required to specify which prospect record to modify.
Fullname The full name of the prospect to update.
E-Mail The email address of the prospect.
Phones A collection of phone numbers to add or update for the prospect.
Gender The gender of the prospect, selectable as Male or Woman.
Birthdate The birthdate of the prospect.
Work The work or occupation of the prospect.
Marital Status The marital status of the prospect.
Document (CPF/CNPJ) The document number of the prospect, such as CPF or CNPJ.
Legal Type The legal type of the prospect, either Physical or Legal entity.
State The state where the prospect is located.
City The city where the prospect is located.
Address The address of the prospect.
Address Number The address number of the prospect.
Complement Address Additional address information or complement.
Neighborhood The neighborhood of the prospect.
CEP The postal code (CEP) of the prospect.
Owners The owners associated with the prospect.
Custom Fields A collection of custom fields to set additional values not predefined in the standard fields.
Encode Custom Fields If enabled, custom fields and option fields are automatically encoded as IDs instead of names or values.

Output

JSON

  • _id - The unique identifier of the updated prospect.
  • fullname - The full name of the updated prospect.
  • email - The email address of the updated prospect.
  • phoneCollection - The collection of phone numbers associated with the updated prospect.
  • gender - The gender of the updated prospect.
  • birthDate - The birthdate of the updated prospect.
  • work - The work or occupation of the updated prospect.
  • maritalStatus - The marital status of the updated prospect.
  • doc - The document number (CPF/CNPJ) of the updated prospect.
  • type - The legal type (Physical or Legal) of the updated prospect.
  • state - The state of the updated prospect.
  • city - The city of the updated prospect.
  • address - The address of the updated prospect.
  • addressNumber - The address number of the updated prospect.
  • complement - The complement address of the updated prospect.
  • neighborhood - The neighborhood of the updated prospect.
  • cep - The postal code (CEP) of the updated prospect.
  • owners - The owners associated with the updated prospect.
  • customFields - Custom fields and their values associated with the updated prospect.

Dependencies

  • Magnet Customer API

Troubleshooting

  • Ensure the Contact ID (prospectId) is correctly provided and exists in the Magnet Customer system to avoid 'not found' errors.
  • If using custom fields, verify that the field IDs or names are correct and that the 'Encode Custom Fields' option is set appropriately to avoid encoding issues.
  • Authentication errors may occur if the API Token or OAuth2 credentials are invalid or expired; verify credentials before running the node.

Links

Discussion