Create Autoresponder Email Draft

Tool name: create-autoresponder-email-draft

Creates an inactive email follow-up draft with an unfiltered audience. By default it sends once immediately after entry when activated; birthday mode needs a date field and time. Ask for the subject: every recipient sees it. Set the audience with update-autoresponder-draft, the delay with configure-autoresponder-trigger and the body with the email editor tools. splitTest makes it a split test, which only creation can decide, with this subject on variant A. Sends nothing.

Input schema

namestring, [ 1 .. 250 ] charactersrequired

Name, unique within the account, at most 250 characters, without HTML

subjectstring, [ 1 .. 150 ] charactersrequired

Subject line every recipient sees, at most 150 characters, without HTML

preheadernull or string, <= 100 characters

Inbox preview line, at most 100 characters; omit to leave it empty

Default:null

notesnull or string, <= 1000 characters

Internal note, at most 1000 characters; omit for none

Default:null

birthdayboolean

true for a birthday follow-up, which goes out on each contact's birthday instead of after a delay

Default:false

birthdayFieldIdnull or string, [ 1 .. 100 ] characters

Required when birthday is true, forbidden otherwise: ID of the date field holding the birthday, from search-custom-fields

Default:null

birthdayTimenull or string^([01][0-9]|2[0-3]):[0-5][0-9]$

Required when birthday is true, forbidden otherwise: time of day "HH:MM" it goes out on the birthday

Default:null

emailEditornull or string

Omit for "drag-and-drop"; "rich-text" only when the account asked for the previous editor. Fixed at creation

Default:null

Enum:"drag-and-drop""rich-text"

splitTestobject

Default:null

accountIdnull or integer, >= 1

User ID of the account; omit for the account of the access token

Default:null

Input example

{
  "name": "string",
  "subject": "string",
  "preheader": null,
  "notes": null,
  "birthday": false,
  "birthdayFieldId": null,
  "birthdayTime": null,
  "emailEditor": "drag-and-drop",
  "splitTest": null,
  "accountId": null
}

Output schema

accountIdintegerrequired

autoresponderIdintegerrequired

kindstringrequired

Enum:"email""sms""birthday-email""birthday-sms"

namestringrequired

notesstringrequired

statusstringrequired

Enum:"draft""paused""scheduled""active"

labelsArray of stringsrequired

isSplitTestbooleanrequired

emailobject or nullrequired

smsobject or nullrequired

triggerobjectrequired

audienceobjectrequired

missingForActivationArray of stringsrequired

editUrlstringrequired

scheduleUrlstringrequired

statisticsUrlstringrequired

Output example

{
  "accountId": 0,
  "autoresponderId": 0,
  "kind": "email",
  "name": "string",
  "notes": "string",
  "status": "draft",
  "labels": [
    "string"
  ],
  "isSplitTest": true,
  "email": {
    "emailId": 0,
    "subject": "string",
    "preheader": "string",
    "reportSpamHeader": true,
    "editorUrl": "string",
    "contentUrl": "string"
  },
  "sms": {
    "smsId": 0,
    "text": "string",
    "senderName": "string",
    "provider": "string",
    "linkTracking": true,
    "contentUrl": "string"
  },
  "trigger": {
    "delayUnit": "immediately",
    "delayValue": 0,
    "dateFieldId": "string",
    "weekdays": [
      0
    ],
    "sendAtTime": "string",
    "birthdayFieldId": "string",
    "birthdayTime": "string",
    "repeat": true,
    "repeatTagIds": [
      0
    ]
  },
  "audience": {
    "mode": "all_contacts"
  },
  "missingForActivation": [
    "string"
  ],
  "editUrl": "string",
  "scheduleUrl": "string",
  "statisticsUrl": "string"
}