Get Autoresponder

Tool name: get-autoresponder

Reads one follow-up campaign (autoresponder): kind, state, email subject and preheader or SMS text, trigger (delay or birthday, weekday window, time of day, repeat tags), audience, what still blocks activation, and app links -- email.editorUrl is what the email editor tools take.

Input schema

autoresponderIdinteger, >= 1required

ID of the follow-up, from search-autoresponders

accountIdnull or integer, >= 1

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

Default:null

Input example

{
  "autoresponderId": 1,
  "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"
}