Imobzi icon

Imobzi

Interagir com a API da Imobzi
Join our community

Actions62

Overview

This node integrates with the Imobzi API to update an existing document record. It allows users to specify a document by its name or ID and modify various fields such as date, description, email, name, phone, title, and value. This operation is useful in scenarios where document metadata needs to be kept current, for example, updating contract documents, invoices, or any other document-related information managed within Imobzi.

Practical examples include:

  • Updating the description or title of a document after receiving new information.
  • Changing contact details like email or phone associated with a document.
  • Adjusting the date or value fields to reflect recent changes.

Properties

Name Meaning
Document Name or ID Select a document from the list or specify its ID using an expression to identify it.
Update Fields Collection of fields to update on the document. Includes:
- Date: Date of the document item (string).
- Description: Description text for the document (string).
- Email: Email address related to the document (string).
- Name: Name associated with the document (string).
- Phone: Phone number related to the document (string).
- Title: Title of the document (string).
- Value: Numeric value associated with the document (number).

Output

The node outputs JSON data representing the updated document object returned by the Imobzi API. The output structure corresponds to the document's properties after the update operation. The key json contains the updated document data.

No binary data output is produced by this node.

Example output snippet (simplified):

{
  "json": {
    "id": "123",
    "date": "2024-06-01",
    "description": "Updated document description",
    "email": "contact@example.com",
    "name": "Document Name",
    "phone": "1234567890",
    "title": "New Title",
    "value": 1000
  }
}

Dependencies

  • Requires an active connection to the Imobzi API via an API key credential configured in n8n.
  • The node uses authenticated HTTP requests to interact with the Imobzi REST endpoints.
  • No additional external dependencies are required beyond the configured API authentication.

Troubleshooting

  • Common issues:

    • Invalid or missing document ID: Ensure the document exists and the ID is correct.
    • Insufficient permissions: Verify that the API key has rights to update documents.
    • Network or API errors: Check connectivity and API status.

  • Error messages:

    • "Recurso "documento" não suportado!": Indicates the resource is not supported; ensure the resource parameter is set correctly.
    • "Operação "update" não suportada!": Means the operation is unsupported; verify the operation parameter.
    • API response errors will be passed through; check the error message for details such as validation failures or authorization issues.

  • To resolve errors, confirm all required parameters are provided, the API credentials are valid, and the document ID exists in the system.

Links and References

Discussion