Skip to main content
PUT
/
updateAutomation
Update automation
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,
    "saveGoogleDoc": true,
    "locale": "<string>",
    "formatNumbersWithLocale": true,
    "pdfExpiration": "<string>",
    "dateCreated": "2023-11-07T05:31:56Z",
    "lastPreviewPdf": "<string>"
  }
}

Authorizations

Authorization
string
header
required

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.

Query Parameters

docId
string
required

The automation ID to update.

Body

application/json
title
string

Automation name.

Google Doc template URL.

newDocumentNameField
string

Field name or formula for generated document names.

isActive
boolean

Whether the automation is active.

saveGoogleDoc
boolean

Save a Google Doc copy alongside the PDF.

googleDocDestinationFolderUrl
string<uri>

Google Drive folder URL for saved documents.

locale
string

Locale for date and number formatting (e.g., en-us, de-de).

formatNumbersWithLocale
boolean

Format numbers using the automation's locale.

pdfExpiration
enum<string> | null

PDF expiration period. never means PDFs never expire, immediate means they expire right away, and other values set the expiration window.

Available options:
never,
immediate,
oneday,
threedays,
oneweek,
twoweeks,
onemonth,
threemonths,
sixmonths,
oneyear
imageOptions
object

Response

Automation updated

message
string
Example:

"Success"

updatedAutomation
object
Last modified on May 26, 2026