curl --request PUT \
--url https://api.docsautomator.co/updateAutomation \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "Updated Invoice Generator",
"isActive": true,
"locale": "en-us"
}
'{
"message": "Success",
"updatedAutomation": {
"_id": "<string>",
"title": "<string>",
"dataSource": {
"name": "<string>"
},
"dataSourceName": "<string>",
"docTemplateLink": "<string>",
"newDocumentNameField": "<string>",
"isActive": true,
"isPreview": true,
"saveGoogleDoc": true,
"locale": "<string>",
"formatNumbersWithLocale": true,
"pdfExpiration": "<string>",
"dateCreated": "2023-11-07T05:31:56Z",
"lastPreviewPdf": "<string>",
"options": {
"lineDeletions": [
"client_vat_id",
"line_items_1_discount"
],
"markdownPlaceholders": [
"project_summary"
],
"hiddenPlaceholders": [
"internal_note"
],
"uniqueValuePlaceholders": [
"project_names"
],
"placeholderDescriptions": {},
"placeholderFormats": {},
"imageOptions": {}
},
"esignature": {
"enabled": true,
"closeType": "signature",
"recipientCount": 123,
"signers": [
{
"signer": 123,
"role": "<string>",
"emailSource": "static",
"email": "<string>",
"name": "<string>"
}
]
},
"description": "<string>",
"attachmentField": "<string>",
"overwriteAttachment": true,
"attachPdfToClickUpTask": true,
"clickUpAttachmentFieldId": "<string>",
"dateFormat": {
"day": "numeric",
"month": "numeric",
"year": "numeric",
"hour12": "true"
},
"fields": "<string>",
"imageOptions": {
"quality": "low",
"maxWidth": 123
},
"googleDocDestinationFolderUrl": "<string>",
"googleDocUrlField": "<string>",
"pdfUrlField": "<string>",
"saveWordDoc": true,
"saveWordInDriveFolderId": "<string>",
"saveWordSubfolderName": "<string>",
"wordAttachmentField": "<string>",
"overwriteWordAttachment": true,
"approval": {
"enabled": true,
"approvers": [
"<string>"
],
"rule": "all",
"condition": {},
"requireAccount": true,
"approverFields": [
{}
]
}
}
}{
"error": "Missing required parameter"
}{
"error": "<string>"
}{
"error": "Not found"
}Update automation
Updates an existing automation’s settings. Send only the settings you want to change. Settings you leave out keep their values. A text, number, true-or-false or list setting is replaced by the value you send. An object setting is merged: keys you send change, and keys you leave out stay. Some settings inside an object are always replaced whole; their descriptions say so. GET /automation returns every setting with its current value.
curl --request PUT \
--url https://api.docsautomator.co/updateAutomation \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "Updated Invoice Generator",
"isActive": true,
"locale": "en-us"
}
'{
"message": "Success",
"updatedAutomation": {
"_id": "<string>",
"title": "<string>",
"dataSource": {
"name": "<string>"
},
"dataSourceName": "<string>",
"docTemplateLink": "<string>",
"newDocumentNameField": "<string>",
"isActive": true,
"isPreview": true,
"saveGoogleDoc": true,
"locale": "<string>",
"formatNumbersWithLocale": true,
"pdfExpiration": "<string>",
"dateCreated": "2023-11-07T05:31:56Z",
"lastPreviewPdf": "<string>",
"options": {
"lineDeletions": [
"client_vat_id",
"line_items_1_discount"
],
"markdownPlaceholders": [
"project_summary"
],
"hiddenPlaceholders": [
"internal_note"
],
"uniqueValuePlaceholders": [
"project_names"
],
"placeholderDescriptions": {},
"placeholderFormats": {},
"imageOptions": {}
},
"esignature": {
"enabled": true,
"closeType": "signature",
"recipientCount": 123,
"signers": [
{
"signer": 123,
"role": "<string>",
"emailSource": "static",
"email": "<string>",
"name": "<string>"
}
]
},
"description": "<string>",
"attachmentField": "<string>",
"overwriteAttachment": true,
"attachPdfToClickUpTask": true,
"clickUpAttachmentFieldId": "<string>",
"dateFormat": {
"day": "numeric",
"month": "numeric",
"year": "numeric",
"hour12": "true"
},
"fields": "<string>",
"imageOptions": {
"quality": "low",
"maxWidth": 123
},
"googleDocDestinationFolderUrl": "<string>",
"googleDocUrlField": "<string>",
"pdfUrlField": "<string>",
"saveWordDoc": true,
"saveWordInDriveFolderId": "<string>",
"saveWordSubfolderName": "<string>",
"wordAttachmentField": "<string>",
"overwriteWordAttachment": true,
"approval": {
"enabled": true,
"approvers": [
"<string>"
],
"rule": "all",
"condition": {},
"requireAccount": true,
"approverFields": [
{}
]
}
}
}{
"error": "Missing required parameter"
}{
"error": "<string>"
}{
"error": "Not found"
}Authorizations
API key from your workspace settings. Pass as Authorization: Bearer <key> or X-API-Key: <key>. Find it at app.docsautomator.co/settings/workspace/api.
Body
PDF expiration period. never (the default) keeps PDFs until you delete them, immediate deletes them about 5 minutes after generation, and other values set the expiration window.
never, immediate, oneday, threedays, oneweek, twoweeks, onemonth, threemonths, sixmonths, oneyear The signing or acceptance step, in the shape GET /automation returns it. Setting up signers for the first time switches signing on, unless you also send enabled. Merges with the stored object. signers and notificationRecipients are replaced as whole lists. Each email template in emailConfig (invitation, reminder, completion) is replaced whole. An invalid value is refused with a 400.
{
"enabled": true,
"signingLanguage": "de",
"expirationDays": 30
}