Bitrix24 icon

Bitrix24

Interact with Bitrix24 CRM and business platform

Overview

The "Update Template" operation in the Document Generator resource of this Bitrix24 node allows users to update an existing document template by specifying its ID and providing new configuration data in JSON format. This is useful for automating document management workflows where templates need to be programmatically modified, such as updating contract templates, invoices, or reports within Bitrix24.

Practical examples include:

  • Automatically updating a sales contract template with new clauses or branding.
  • Modifying invoice templates to reflect updated tax rules or company information.
  • Adjusting report templates dynamically based on changing business requirements.

Properties

Name Meaning
Authentication Method used to authenticate with Bitrix24: OAuth2 (recommended), Webhook (simpler), or API Key.
Template ID The unique identifier of the document template to update.
Template Data The new configuration for the template, provided as a JSON object representing the template structure and content.

Output

The node outputs JSON data representing the result of the update operation. Typically, this will include confirmation details such as success status, updated template metadata, or error messages if the update failed.

If the node encounters an error during execution and "Continue On Fail" is enabled, it outputs a JSON object containing:

  • error: The error message describing what went wrong.
  • resource: The resource name ("documentGenerator").
  • timestamp: The ISO timestamp when the error occurred.

No binary data output is indicated for this operation.

Dependencies

  • Requires authentication credentials for Bitrix24 via one of the supported methods: OAuth2, webhook URL, or API key.
  • Relies on Bitrix24's API endpoints for document template management.
  • No additional external services are required beyond Bitrix24 itself.

Troubleshooting

  • Common Issues:

    • Invalid or missing Template ID: Ensure the Template ID corresponds to an existing template in Bitrix24.
    • Malformed JSON in Template Data: Verify that the JSON configuration is correctly formatted and valid according to Bitrix24's template schema.
    • Authentication failures: Check that the selected authentication method is properly configured and credentials are valid.
    • API rate limits or connectivity issues with Bitrix24.
  • Error Messages:

    • Errors returned from Bitrix24 API will be included in the output JSON under the error field if "Continue On Fail" is enabled.
    • Common errors include authorization errors, invalid parameters, or server errors.
  • Resolution Tips:

    • Double-check all input parameters for correctness.
    • Validate JSON syntax before passing it to the node.
    • Confirm that the API credentials have sufficient permissions.
    • Review Bitrix24 API documentation for any changes or limitations.

Links and References

Discussion