Substy Developers
Automations

Get messaging automation

Read one messaging automation's trigger, audience and message settings by ID.

GET/v1/agencies/{agencyId}/automations/{automationId}

Read one messaging automation's trigger, audience and message settings by ID.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

agencyId*string
Length1 <= length
automationId*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/agencies/string/automations/string" \  -H "Authorization: Bearer YOUR_API_KEY"
{  "data": {    "sequences": [      {        "messages": [          {            "medias": [              {                "id": "string",                "createdAt": "2019-08-24T14:15:22Z",                "messageId": "string",                "updatedAt": "2019-08-24T14:15:22Z",                "position": 0,                "mediaId": "string",                "isPreview": true              }            ],            "id": "string",            "createdAt": "2019-08-24T14:15:22Z",            "delay": 0,            "price": null,            "updatedAt": "2019-08-24T14:15:22Z",            "content": null,            "position": 0,            "sequenceId": "string",            "aiGenerated": true          }        ],        "id": "string",        "createdAt": "2019-08-24T14:15:22Z",        "name": "string",        "updatedAt": "2019-08-24T14:15:22Z",        "position": 0,        "automationId": "string"      }    ],    "notifyEmployees": [      {        "employeeId": "string",        "employee": {          "id": "string",          "employeeId": "string"        }      }    ],    "enabled": true,    "creatorId": "string",    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "name": "string",    "updatedAt": "2019-08-24T14:15:22Z",    "endDate": null,    "trigger": "FAN_SUBSCRIBES_FIRST_TIME",    "frequency": "SEND_ONCE",    "keywords": [      "string"    ],    "keywordMatchType": "CONTAINS",    "scheduledDate": null,    "scheduledTime": null,    "expiryDate": null,    "expiryTime": null,    "actionSendMessage": true,    "actionStopAI": true,    "actionNotifyEmployee": true,    "actionAddToList": true,    "notifyEmployeeMessage": null,    "targetListIds": [      "string"    ],    "fanListsIncluded": [      "string"    ],    "fanListsExcluded": [      "string"    ],    "totalSpendMin": null,    "totalSpendMax": null,    "tipsReceivedMin": null,    "tipsReceivedMax": null,    "subscriptionDurationMin": null,    "subscriptionDurationUnit": null,    "onlineStatusOnly": true,    "excludeRecentlyMessaged": true,    "excludeRecentlyMessagedTime": null,    "excludeMediaViewers": true,    "excludeUnreadMessages": true,    "excludeCreatorAccounts": true,    "effectiveType": "IMMEDIATELY",    "randomDelayMin": null,    "randomDelayMax": null,    "expiryType": "NEVER_EXPIRE",    "unsendMessages": true,    "unsendAfter": null,    "stopMessageOnReply": true,    "stoppedAt": null,    "totalSent": 0,    "totalEarned": "string",    "amountPurchased": 0,    "createdByEmployeeId": null,    "stoppedByEmployeeId": null  },  "meta": {    "requestId": "string"  }}

Create messaging automation POST

Create a creator messaging automation with the supplied trigger, audience and message configuration. An enabled automation can send messages to real fans when triggered.

Update messaging automation PATCH

Update an existing messaging automation's configuration. Changes to an enabled automation affect subsequent triggered sends.