Asaas icon

Asaas

Interagir com a API do Asaas

Actions6

Overview

This node integrates with the Asaas API to update customer information. It allows users to modify details of an existing customer by specifying the customer's unique identifier and the fields to update. This is useful in scenarios where customer data changes over time, such as updating contact information, address, or other personal details.

Practical examples include:

  • Updating a customer's email or phone number after they provide new contact info.
  • Changing the customer's address or postal code when they move.
  • Marking a customer as foreign or disabling notifications for them.

Properties

Name Meaning
ID Do Cliente Unique identifier of the customer to be updated.
Update Fields Collection of fields to update for the customer. Possible fields:
- Bairro (province): Customer's neighborhood.
- Celular (mobilePhone): Customer's mobile phone number.
- CEP (postalCode): Customer's postal code.
- Cliente Estrangeiro (foreignCustomer): Boolean indicating if the customer is foreign.
- Complemento (complement): Address complement.
- CPF/CNPJ (cpfCnpj): Customer's tax identification number.
- Email (email): Customer's email address.
- Emails Adicionais (additionalEmails): Additional emails separated by commas.
- Empresa (company): Customer's company name.
- Endereço (address): Customer's address.
- Inscrição Estadual (stateInscription): State registration number.
- Inscrição Municipal (municipalInscription): Municipal registration number.
- Nome (name): Customer's full name.
- Nome Do Grupo (groupName): Customer's group name.
- Notificação Desabilitada (notificationDisabled): Boolean to disable notifications.
- Número (addressNumber): Address number.
- Observações (observations): Notes about the customer.
- Referência Externa (externalReference): External reference for the customer.
- Telefone (phone): Customer's phone number.

Output

The node outputs the updated customer data as JSON. The structure corresponds to the response from the Asaas API after a successful update operation. It includes all relevant customer fields reflecting the new state after the update.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the Asaas API.
  • The node uses either the production or sandbox environment of the Asaas API based on the configured environment in the credentials.
  • Proper network access to the Asaas API endpoints is necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing customer ID will cause the update to fail.
    • Providing invalid field values (e.g., malformed email) may result in API errors.
    • Network connectivity problems can prevent communication with the Asaas API.
    • Using incorrect API credentials or environment settings will cause authentication failures.

  • Error messages:

    • Errors returned from the Asaas API are passed through; typical messages include validation errors or authorization failures.
    • If the node is set to continue on failure, error messages will appear in the output JSON under an error property.

  • Resolutions:

    • Verify that the customer ID exists and is correct.
    • Ensure all input fields conform to expected formats.
    • Check API key validity and environment configuration.
    • Confirm network connectivity to Asaas API endpoints.

Links and References

Discussion