Magnet Customer icon

Magnet Customer

Consume Magnet Customer API

Actions104

Organization → Create

AI-generated

Overview

This node operation creates a new organization record in the Magnet Customer system. It is useful for automating the addition of organization contacts with detailed information such as fullname, email, phones, address, and custom fields. For example, it can be used to add new client companies or partners into the CRM automatically from form submissions or other data sources.

Use Case Examples

  1. Create a new organization contact with fullname, email, and phone numbers.
  2. Add an organization with detailed address information including city, state, and postal code.
  3. Set custom fields for an organization to capture additional data not predefined in the system.

Properties

Name Meaning
Authentication Selects the authentication method to use for the API request (API Token or OAuth2).
Fullname The fullname of the organization contact.
E-Mail The e-mail address of the organization contact.
Phones A collection of phone numbers to add to the organization contact, allowing multiple phone entries with custom values.
Birthdate The birthdate of the organization contact.
Document (CPF/CNPJ) The document identifier of the organization contact, such as CPF or CNPJ.
State The state where the organization contact is located.
City The city where the organization contact is located.
Address The street address of the organization contact.
Address Number The address number of the organization contact.
Complement Address Additional address information or complement for the organization contact.
Neighborhood The neighborhood of the organization contact.
CEP The postal code (CEP) of the organization contact.
Owners The owners associated with the organization contact.
Custom Fields A collection of custom fields to set additional values for the organization contact that are not predefined. Each custom field requires a field name or ID and a value.

Output

JSON

  • _id - The unique identifier of the created organization.
  • fullname - The fullname of the created organization.
  • email - The email address of the created organization.
  • phones - The list of phone numbers associated with the created organization.
  • birthDate - The birthdate of the created organization.
  • doc - The document identifier (CPF/CNPJ) of the created organization.
  • state - The state of the created organization.
  • city - The city of the created organization.
  • address - The street address of the created organization.
  • addressNumber - The address number of the created organization.
  • complement - The complement address of the created organization.
  • neighborhood - The neighborhood of the created organization.
  • cep - The postal code (CEP) of the created organization.
  • owners - The owners associated with the created organization.
  • customFields - Custom fields set for the created organization.

Dependencies

  • Magnet Customer API with either API Token or OAuth2 authentication

Troubleshooting

  • Ensure that the API credentials (API Token or OAuth2) are correctly configured and have the necessary permissions to create organizations.
  • Verify that required fields such as fullname and email are provided and correctly formatted.
  • If custom fields are used, ensure the field IDs or names are valid and exist in the Magnet Customer system.
  • Common error messages may include authentication failures, missing required fields, or invalid field values. Check the error message details and adjust the input accordingly.

Discussion