Configure Autoresponder Trigger

Tool name: configure-autoresponder-trigger

Configures when a follow-up campaign (autoresponder) goes out to a contact that entered its audience; refused while it is active. Email/SMS follow-ups: a delay or the date in a date-and-time field (custom-field); for days, weeks and months also a weekday window and time of day; and, only before it ever went out, whether renewed tagging with the repeat tags sends it again. Birthday follow-ups: date field and time of day. Omitted values stay; values that do not fit the kind are refused. Activates nothing.

Input schema

autoresponderIdinteger, >= 1required

ID of the follow-up to configure

delayUnitnull or string

Email/SMS follow-ups: immediately, seconds, minutes, hours, days, weeks, months or custom-field; omit to keep

Default:null

Enum:"immediately""seconds""minutes""hours""days""weeks""months""custom-field"

delayValuenull or integer, [ 1 .. 999 ]

Number of delayUnit to wait, 1 to 999; not used for immediately and custom-field; omit to keep

Default:null

dateFieldIdnull or string, [ 1 .. 100 ] characters

For delayUnit custom-field: ID of a date-and-time field whose date the follow-up waits for

Default:null

weekdaysArray of integers, <= 7 items, unique

Default:null

sendAtTimenull or string, <= 5 characters

Only for days, weeks and months: time of day "HH:MM" it goes out at; empty string means as soon as the delay is over; omit to keep

Default:null

birthdayFieldIdnull or string, [ 1 .. 100 ] characters

Birthday follow-ups: ID of the date field holding the birthday; omit to keep

Default:null

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

Birthday follow-ups: time of day "HH:MM" it goes out on the birthday; omit to keep

Default:null

repeatnull or boolean

Email/SMS follow-ups, only before it ever went out: whether renewed tagging with a repeat tag sends it again; omit to keep

Default:null

repeatTagIdsArray of integers, <= 50 items, unique

Default:null

accountIdnull or integer, >= 1

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

Default:null

Input example

{
  "autoresponderId": 1,
  "delayUnit": "immediately",
  "delayValue": null,
  "dateFieldId": null,
  "weekdays": null,
  "sendAtTime": null,
  "birthdayFieldId": null,
  "birthdayTime": null,
  "repeat": null,
  "repeatTagIds": 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"
}