Bitrix24 icon

Bitrix24

Interact with Bitrix24 CRM and business platform

Actions290

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 template configuration data in JSON format. This operation is useful when you want to modify or refine document templates stored in Bitrix24 without creating a new one from scratch.

Common scenarios include:

  • Updating contract templates with new clauses or formatting.
  • Modifying invoice templates to reflect updated branding or legal requirements.
  • Adjusting report templates dynamically based on changing business needs.

For example, a user might automate updating a sales proposal template whenever product details change, ensuring all generated documents use the latest information.

Properties

Name Meaning
Authentication Method 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.

Output

The node outputs an array of items where each item contains a json property with the response from Bitrix24 after attempting to update the template. The exact structure depends on the Bitrix24 API response but typically includes confirmation of the update or error details if the update failed.

No binary data output is indicated for this operation.

Dependencies

  • Requires authentication credentials for Bitrix24 via OAuth2, webhook URL, or API key.
  • Depends on Bitrix24 API availability and permissions to update document templates.
  • No additional external services are required beyond Bitrix24.

Troubleshooting

  • Common Issues:

    • Invalid or missing Template ID will cause the update to fail.
    • Malformed JSON in Template Data can lead to API errors.
    • Insufficient permissions or incorrect authentication method may result in authorization errors.
    • Network issues or Bitrix24 API downtime can cause request failures.
  • Error Messages:

    • Errors returned from Bitrix24 API will be included in the output JSON under an error field if "Continue On Fail" is enabled.
    • Typical messages include "Template not found", "Invalid JSON format", or "Authentication failed".
  • Resolutions:

    • Verify the Template ID exists and is correct.
    • Ensure the JSON for Template Data is valid and matches expected schema.
    • Confirm that the selected authentication method is properly configured and has necessary permissions.
    • Check network connectivity and Bitrix24 service status.

Links and References

Discussion