Substy Developers
Automations

Set messaging automation enabled

Set whether a messaging automation is enabled. Enabling it permits triggered sends to real fans.

PATCH/v1/agencies/{agencyId}/automations/{automationId}/activation

Set whether a messaging automation is enabled. Enabling it permits triggered sends to real fans.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

agencyId*string
Length1 <= length
automationId*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 PATCH "https://example.com/v1/agencies/string/automations/string/activation" \  -H "Authorization: Bearer YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "enabled": true  }'
{  "data": {    "enabled": true,    "creatorId": "string",    "name": "string",    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "endDate": null,    "trigger": "FAN_BIRTHDAY",    "keywords": [      "string"    ],    "keywordMatchType": "CONTAINS",    "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,    "frequency": "SEND_EVERY_TIME",    "effectiveType": "IMMEDIATELY",    "randomDelayMin": null,    "randomDelayMax": null,    "scheduledDate": null,    "scheduledTime": null,    "expiryType": "NEVER_EXPIRE",    "expiryDate": null,    "expiryTime": null,    "unsendMessages": true,    "unsendAfter": null,    "stopMessageOnReply": true,    "actionSendMessage": true,    "actionStopAI": true,    "actionNotifyEmployee": true,    "actionAddToList": true,    "actionFollowFan": true,    "followFanDailyCap": null,    "followFanExcludeChargebacks": true,    "notifyEmployeeMessage": null,    "targetListIds": [      "string"    ],    "createdByEmployeeId": null,    "stoppedByEmployeeId": null,    "stoppedAt": null,    "totalSent": 0,    "totalEarned": "string",    "amountPurchased": 0  },  "meta": {    "requestId": "string",    "operationId": "3051932a-fdd2-48fa-b330-7e7d41535969",    "status": "COMPLETED"  }}

Copy messaging automation to creator POST

Copy an existing messaging automation to another accessible creator using the supported target settings.

Get messaging automation follow results GET

Read the results of an automation's "Follow the fan" action (OnlyFans, subscription expired trigger): fans followed back and followed fans who subscribed again within 30 days, over the last 24 hours, 7 days, 30 days and in total, plus the last 30 days of expiries by outcome.