Skip to main content
PUT
Update automation

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.

isPreview
boolean

Test mode. true makes watermarked test documents, false makes live documents. New automations and copies start with true. Going live needs a confirmed account email.

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 (the default) keeps PDFs until you delete them, immediate deletes them about 5 minutes after generation, 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