Substy Automations
Create messaging automation
Create a creator messaging automation with the supplied trigger, audience and message configuration. An enabled automation can send messages to real fans when triggered.
POST
/v1/agencies/{agencyId}/creators/{creatorId}/automationsCreate a creator messaging automation with the supplied trigger, audience and message configuration. An enabled automation can send messages to real fans when triggered.
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Path Parameters
agencyId*string
Length
1 <= lengthcreatorId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/agencies/string/creators/string/automations" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "data": { "name": "string", "trigger": "FAN_SUBSCRIBES_FIRST_TIME", "includeFilters": { "totalSpend": { "min": 0, "max": 0, "enabled": true }, "tippedOver": { "min": 0, "max": 0, "enabled": true }, "subscribedOver": { "value": 0, "unit": "DAYS", "enabled": true }, "onlineFans": true }, "excludeFilters": { "recentMessages": {}, "viewedMedia": true, "unreadMessages": true, "creators": true }, "frequency": "SEND_ONCE", "effective": "IMMEDIATELY", "expiry": "NEVER_EXPIRE", "autoUnsend": true } }'{ "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" } ], "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", "operationId": "3051932a-fdd2-48fa-b330-7e7d41535969", "status": "COMPLETED" }}