OrbitX icon

OrbitX

Consume OrbitX API

Overview

The Atualizar Contato (Update Contact) operation in the OrbitX n8n node allows you to update an existing contact's information in the OrbitX system. This is useful for keeping your contact database synchronized with changes, such as updating a person's name, phone number, email, or CPF (Brazilian individual taxpayer registry identification).

Common scenarios:

  • Keeping customer records up-to-date when their details change.
  • Integrating CRM updates with WhatsApp-based communication platforms.
  • Automating user data corrections from other business systems.

Practical example:
If a customer's email address or CPF changes, you can use this node to automatically update their record in OrbitX whenever a change is detected in your main database.


Properties

Name Type Meaning
Nome Completo String The full name of the contact. Required for updating the contact.
Número String The contact's phone number. Required and used to identify which contact to update.
Email String The contact's email address. Optional; will be updated if provided.
CPF String The contact's CPF (Cadastro de Pessoas Físicas). Optional; will be updated if provided.

Output

The output is a JSON object containing the result of the update operation as returned by the OrbitX API. The structure typically includes confirmation of the update and may echo back the updated contact data or status message.

Example output:

[
  {
    "success": true,
    "message": "Contact updated successfully",
    "data": {
      "name": "João Silva",
      "number": "+5511999999999",
      "email": "joao.silva@email.com",
      "cpf": "123.456.789-00"
    }
  }
]

Note: The exact fields depend on the OrbitX API response.


Dependencies

  • OrbitX API credentials are required:
    • endpointUrl: Base URL for the OrbitX API.
    • bearerToken: Authentication token.
    • secretKey: Used as externalKey in requests.
  • The node must be configured with valid OrbitX API credentials in n8n.

Troubleshooting

Common issues:

  • Invalid credentials: If the bearer token or endpoint URL is incorrect, the node will fail with authentication errors.
  • Missing required fields: If "Nome Completo" or "Número" is not provided, the node will throw an error indicating missing parameters.
  • API errors: If the contact does not exist or there is a server-side issue, the API may return an error message.

Error messages and resolutions:

  • "EndpointURL inválida para extrair subdomínio": Check that the endpoint URL in your credentials is correct and follows the expected format.
  • "401 Unauthorized": Ensure your bearer token is valid and has not expired.
  • "Contact not found": Verify the phone number ("Número") matches an existing contact in OrbitX.

Links and References


Discussion