Actions18
Overview
The node integrates with the Autentique API to manage digital documents for electronic signatures. Specifically, the Edit Document operation allows users to update metadata of an existing document such as its name and signature-related settings.
This operation is useful when you need to modify document details after creation without re-uploading or recreating it. For example, you might want to rename a contract, enable or disable whether the document can be refused by signatories, or specify if signatures must follow a particular order.
Practical scenarios include:
- Correcting or updating the document title before sending it out for signature.
- Changing signature workflow rules like making signatures sortable or allowing refusal.
- Adjusting document properties dynamically based on business logic or user input.
Properties
| Name | Meaning |
|---|---|
| Document ID | The unique identifier of the document to edit (required). |
| Document Name | The new name/title of the document. |
| Refusable | Boolean flag indicating whether the document can be refused by signatories (true or false). |
| Sortable | Boolean flag indicating whether signatures must follow a specific order (true or false). |
Output
The output JSON contains the updated document information with the following fields:
id: The document's unique identifier.name: The updated name of the document.refusable: Whether the document can be refused.sortable: Whether the signatures must follow a specific order.
Example output JSON structure:
{
"id": "doc_xxxxx",
"name": "Updated Document Name",
"refusable": true,
"sortable": false
}
No binary data is returned by this operation.
Dependencies
- Requires an API key credential for authenticating requests to the Autentique API.
- The node sends GraphQL mutation requests to the endpoint
https://api.autentique.com.br/v2/graphql. - Proper network access to the Autentique API 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.
- Insufficient permissions: The API key used must have rights to edit documents. Permission errors may occur otherwise.
- Invalid property values: For example, setting non-boolean values for
refusableorsortablemay cause errors. - Network issues: Connectivity problems or incorrect base URL configuration will prevent successful API calls.
- API errors: The API may return errors if the document is locked, archived, or in a state that disallows editing.
To resolve errors:
- Verify all required parameters are provided and correctly formatted.
- Check API credentials and permissions.
- Review API response messages for specific error details.
- Confirm network connectivity and endpoint accessibility.
Links and References
- Autentique API Documentation (general reference for API capabilities)
- GraphQL Mutation for Editing Document (if available publicly)
This summary focuses solely on the static analysis of the Edit operation for the Document resource within the Autentique node implementation.