Sign in
Automations

Update automation

Updates an existing automation's settings. Only the fields included in the request body are updated.

put/updateAutomation

Query parameters

docIdstring required

The automation ID to update.

Request body

titlestring

Automation name.

docTemplateLinkstring uri

Google Doc template URL.

newDocumentNameFieldstring

Field name or formula for generated document names.

isActiveboolean

Whether the automation is active.

saveGoogleDocboolean

Save a Google Doc copy alongside the PDF.

googleDocDestinationFolderUrlstring uri

Google Drive folder URL for saved documents.

localestring

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

formatNumbersWithLocaleboolean

Format numbers using the automation's locale.

pdfExpiration'never' | 'immediate' | 'oneday' | 'threedays' | 'oneweek' | 'twoweeks' | 'onemonth' | 'threemonths' | 'sixmonths' | 'oneyear' nullable

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

Response

Automation updated

messagestring

Example response

{
  "message": "Success"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.