Skip to content

Update Automation Email

Tool name: update-automation-email

Updates supplied automation email settings at the current revision; put every setting to change into one call, as parallel calls with the same revision fail but the first. Emails used by active or scheduled automations can be updated, as in the app; the change applies to their next sends. Content and action assignment use separate tools; sends nothing.

Input schema

emailIdinteger, >= 1required
revisionstring^[a-f0-9]{64}$required
settingsobjectrequired
accountIdnull or integer, >= 1
Default:null
Input example
{ "emailId": 1, "revision": "string", "settings": { "metaLabels": [ "string" ], "gmailPreview": "string", "crmTemplate": 0, "invoiceTemplate": 0, "firstAsTransactional": 0, "aiContext": { "id": "string", "name": "string", "userPrompt": "string", "fieldIds": [ "string" ], "tagIds": [ 1 ] }, "aiSubject": { "id": "string", "name": "string", "userPrompt": "string", "fieldIds": [ "string" ], "tagIds": [ 1 ] }, "name": "string", "notes": "string", "subject": "string", "senderName": "string", "senderEmail": "string", "replyEmail": "string", "ccEmail": "string", "bccEmail": "string", "senderDomain": "string", "signature": 0, "linkTracking": 0, "reportSpamEnabled": 0 }, "accountId": null }

Output schema

emailIdintegerrequired
kindstringrequired
revisionstringrequired
namestringrequired
subjectstringrequired
senderNamestringrequired
senderEmailstringrequired
replyEmailstringrequired
signatureIdintegerrequired
contentStatusintegerrequired
editorUrlstringrequired
usedByAutomationIdsArray of integersrequired
deletedbooleanrequired
smartTagsArray of any or objectrequired
settingsArray of any or objectrequired
effectiveSenderobject or null
Output example
{ "emailId": 0, "kind": "string", "revision": "string", "name": "string", "subject": "string", "senderName": "string", "senderEmail": "string", "replyEmail": "string", "signatureId": 0, "contentStatus": 0, "editorUrl": "string", "usedByAutomationIds": [ 0 ], "deleted": true, "smartTags": { "property1": 0, "property2": 0 }, "settings": {}, "effectiveSender": { "senderMode": "explicit", "fromName": "string", "fromNameSource": "email", "fromEmail": "string", "fromEmailSource": "email", "replyToEmail": "string", "replyToEmailSource": "email", "signatureSelection": "fixed", "signatureId": 0, "signatureName": "string", "sendingDomain": "string", "sendingDomainKind": "customer", "sendingDomainSource": "from_address", "dependsOnContactTags": true, "senderIdentity": { "effectiveSenderEmail": "string", "customerDomain": "string", "normalizedSenderDomain": "string", "status": "ready", "isUsable": true, "senderEmailOptions": [ "string" ], "senderDomainOptions": [ "string" ] } } }