Skip to main content
PUT

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. It cannot be empty.

description
string

What the automation is for and what data it needs, at most 2,000 characters. API clients and AI tools read it to pick the right automation.

Maximum string length: 2000

Google Doc template URL.

newDocumentNameField
string

The field in your data source whose value becomes the file name of new documents.

attachmentField
string

The field in your data source that receives the PDF.

overwriteAttachment
boolean

true replaces the file already in the attachment field. false adds the new PDF next to it.

attachPdfToClickUpTask
boolean

ClickUp only. Attach the PDF to the task.

clickUpAttachmentFieldId
string

ClickUp only. The id of a Files custom field that receives the PDF. Send an empty text ("") to attach the PDF to the task itself.

locale
string

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

dateFormat
object

How dates are written. Merges with the stored object.

Example:
formatNumbersWithLocale
boolean

Format numbers in the automation's locale.

fields
string

The mapping of placeholders to data source fields, as JSON text (a string, not an object), for example "{\"client_name\":\"fldXXXX\"}" with an Airtable field id. The mapping is replaced whole. Send every placeholder mapping you want to keep.

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.

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

Quality and largest width of every image in the document. Lower quality and a smaller width make smaller files. Merges with the stored object.

Example:
saveGoogleDoc
boolean

Save a Google Doc copy next to the PDF.

googleDocDestinationFolderUrl
string<uri>

Google Drive folder URL for saved documents.

googleDocUrlField
string

The field in your data source that receives the link to the Google Doc copy.

pdfUrlField
string

The field in your data source that receives the link to the PDF.

saveWordDoc
boolean

Also save a Word (.docx) file.

saveWordInDriveFolderId
string

The id of the Google Drive folder for the Word file.

saveWordSubfolderName
string

A subfolder for the Word file inside that folder. It can contain placeholders.

wordAttachmentField
string

The field in your data source that receives the Word file.

overwriteWordAttachment
boolean

true replaces the Word file already in the field. false adds the new one next to it.

options
object

Settings for single placeholders. Send only the settings you want to change. Each list or map you send replaces the stored one whole. GET /automation returns the current values.

esignature
object

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.

Example:
approval
object

Approval before a document goes out. Business plan and up; on other plans the only change allowed is {"enabled": false}. Approvers from data source fields are set in the app only. Merges with the stored object.

Example:

Response

Automation updated

message
string
Example:

"Success"

updatedAutomation
object