Substy Developers
Automations

List creator messaging automations

List the messaging automations configured for one creator.

GET/v1/agencies/{agencyId}/creators/{creatorId}/automations

List the messaging automations configured for one creator.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

agencyId*string
Length1 <= length
creatorId*string

Query Parameters

enabled?boolean
searchMessage?string
statusFilter?string
triggerFilter?|string
sendToFilter?string
employeeId?string
page?integer
Range1 <= value <= 9007199254740991
Default1
pageSize?integer
Range1 <= value <= 100
Default10

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/creators/string/automations" \  -H "Authorization: Bearer YOUR_API_KEY"
{  "data": {    "automations": [      {        "createdByEmployeeId": "string",        "stoppedByEmployeeId": "string",        "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"            }          }        ],        "createdByEmployee": null,        "stoppedByEmployee": null,        "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      }    ],    "total": 0,    "page": 0,    "pageSize": 0,    "totalPages": 0  },  "meta": {    "requestId": "string"  }}

Delete fan segment DELETE

Delete a saved audience segment from the specified creator.

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.