Actions19
Overview
The node integrates with the Autentique API to manage digital documents for electronic signatures. Specifically, the Edit Document operation allows users to update various properties of an existing document such as its name, message to signatories, reminder frequency, signature order, deadline, footer position, and visual styles.
This operation is useful in scenarios where a document's metadata or signing workflow needs adjustment after creation but before or during the signing process. For example, you might want to change the document's name, add a custom message for signatories, set automatic reminders, or modify signature requirements without recreating the document.
Practical examples:
- Updating the deadline for signing a contract.
- Changing the message sent to signatories to provide additional instructions.
- Enabling or disabling whether the document can be refused.
- Adjusting the footer position or enabling a new signature style for better presentation.
Properties
| Name | Meaning |
|---|---|
| Document ID | The unique identifier of the document to edit (required). |
| Document Name | New name/title of the document. |
| Refusable | Whether the document can be refused by signatories (true/false). |
| Sortable | Whether signatures must follow a specific order (true/false). |
| Message | Custom message sent via email to the signatories. |
| Reminder | Frequency of automatic reminders sent to signatories. Options: None, Daily, Weekly. |
| Stop on Rejected | Whether to stop the signing process if the document is rejected (true/false). |
| New Signature Style | Whether to use the new signature style interface (true/false). |
| Show Audit Page | Whether to show the audit page after signing (requires new signature style enabled). |
| Deadline At | ISO 8601 formatted date/time string specifying the deadline for signing the document. |
| Footer Position | Position of the footer on the document. Options: None, Bottom, Left, Right. |
Output
The output JSON contains the updated document information returned from the API after the edit mutation. It includes fields such as:
id: Document unique identifier.name: Updated document name.message: Custom message for signatories.reminder: Reminder frequency setting.refusable: Boolean indicating if the document can be refused.sortable: Boolean indicating if signature order is enforced.stop_on_rejected: Boolean indicating if signing stops on rejection.new_signature_style: Boolean for new signature style usage.show_audit_page: Boolean for showing audit page.deadline_at: Deadline datetime for signing.footer: Footer position.created_at: Timestamp when the document was created.
No binary data is output by this operation.
Dependencies
- Requires an API key credential for authenticating with the Autentique API.
- The node sends GraphQL requests to the Autentique API endpoint at
https://api.autentique.com.br/v2. - Proper network connectivity to the Autentique service is necessary.
Troubleshooting
- Missing or invalid Document ID: The operation requires a valid document ID. Ensure the ID is correct and corresponds to an existing document.
- Authentication errors: Verify that the API key credential is correctly configured and has sufficient permissions.
- Invalid property values: For example, the
deadlineAtmust be a valid ISO 8601 datetime string; invalid formats may cause errors. - API rate limits or downtime: If requests fail repeatedly, check for API rate limiting or service availability issues.
- Conflicting settings: Some options depend on others, e.g.,
showAuditPagerequiresnewSignatureStyleto be true; misconfiguration may lead to unexpected behavior.
Links and References
- Autentique API Documentation (general reference for API capabilities)
- GraphQL Mutation for Updating Document (mutation details)
This summary covers the "Edit" operation for the "Document" resource based on the provided source code and input properties.