DOdocsautomator
Automations

Update automation

Changed on

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

put/updateAutomation

Request

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.

isPreviewboolean

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.

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 (the default) keeps PDFs until you delete them, immediate deletes them about 5 minutes after generation, and other values set the expiration window.

Example request

{
  "options": {
    "lineDeletions": [
      "client_vat_id",
      "line_items_1_discount"
    ],
    "markdownPlaceholders": [
      "project_summary"
    ]
  }
}

Response

Automation updated

messagestring

Example response

{
  "message": "Success",
  "updatedAutomation": {
    "options": {
      "lineDeletions": [
        "client_vat_id",
        "line_items_1_discount"
      ],
      "markdownPlaceholders": [
        "project_summary"
      ]
    }
  }
}

Changes

  • 3d5b3e8ecee5Revision changes
    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status

  • f06beeb4eaabRevision changes
    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status