Magnet Customer icon

Magnet Customer

Consume Magnet Customer API

Actions104

Organization → Update

AI-generated

Overview

This node updates an existing organization in the Magnet Customer system. It allows users to modify various details of an organization such as fullname, email, phone numbers, address details, birthdate, document ID, state, city, neighborhood, postal code (CEP), owners, and custom fields. It supports authentication via API Token or OAuth2. This node is useful for scenarios where an organization’s information needs to be kept current, such as updating contact details or adding custom attributes.

Use Case Examples

  1. Updating the email and phone number of an organization after receiving new contact information.
  2. Modifying the address and adding custom fields to an organization record to reflect changes in location or additional metadata.

Properties

Name Meaning
Authentication Method of authentication to use for the API request, either API Token or OAuth2.
Organization ID The unique identifier of the organization to update. This is required to specify which organization record to modify.
Fullname The full name of the organization contact to update.
E-Mail The email address of the organization contact to update.
Phones A collection of phone numbers to add or update for the organization contact.
Birthdate The birthdate of the organization contact.
Document (CPF/CNPJ) The document identifier (such as CPF or CNPJ) of the organization contact.
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 number of the address for 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 Custom fields to set for the organization contact, allowing additional data not predefined in the standard fields.
Encode Custom Fields If set to true, custom fields are automatically encoded, allowing users to specify custom fields by name instead of ID, and option fields by value instead of ID.

Output

JSON

  • _id - The unique identifier of the updated organization.
  • fullname - The full name of the updated organization contact.
  • email - The email address of the updated organization contact.
  • phoneCollection - The collection of phone numbers associated with the updated organization.
  • birthDate - The birthdate of the updated organization contact.
  • doc - The document identifier (CPF/CNPJ) of the updated organization contact.
  • state - The state of the updated organization contact.
  • city - The city of the updated organization contact.
  • address - The street address of the updated organization contact.
  • addressNumber - The address number of the updated organization contact.
  • complement - The complement address of the updated organization contact.
  • neighborhood - The neighborhood of the updated organization contact.
  • cep - The postal code (CEP) of the updated organization contact.
  • owners - The owners associated with the updated organization contact.
  • customFields - Custom fields set on the updated organization contact.

Dependencies

  • An API key credential or OAuth2 token for authenticating with the Magnet Customer API

Troubleshooting

  • Ensure the Organization ID is correctly specified and exists in the Magnet Customer system to avoid 'not found' errors.
  • Verify that the authentication credentials (API Token or OAuth2) are valid and have sufficient permissions to update organization data.
  • If custom fields are used, ensure that the field names or IDs are correct and that encoding is properly handled if 'Encode Custom Fields' is enabled.

Discussion