Substy Developers
Campaigns

Create mass message

Create a bulk campaign for the selected audience, with supported media, PPV price and scheduling. This can send to real fans; inspect the campaign state to determine delivery progress.

POST/v1/agencies/{agencyId}/creators/{creatorId}/mass-messages

Create a bulk campaign for the selected audience, with supported media, PPV price and scheduling. This can send to real fans; inspect the campaign state to determine delivery progress.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

agencyId*string
Length1 <= length
creatorId*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/mass-messages" \  -H "Authorization: Bearer YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "text": "string"  }'
{  "data": {    "createdByEmployee": {      "employee": {        "id": "string",        "createdAt": "2019-08-24T14:15:22Z",        "timezone": "string",        "updatedAt": "2019-08-24T14:15:22Z",        "telegramEnabled": true,        "discordEnabled": true,        "notifyPurchase": true,        "notifyNewMessage": true,        "notifyHandover": true,        "notifyNewSubscriber": true,        "notifyNoScriptLeft": true,        "notifyLowBalance": true,        "discordWebhookUrl": null,        "telegramChatId": null,        "telegramUsername": null,        "inAppEnabled": true,        "emailEnabled": true      },      "agencyId": "string",      "isOwner": true,      "id": "string",      "updatedAt": "2019-08-24T14:15:22Z",      "imported": true,      "importedAt": null,      "color": null,      "employeeId": "string",      "roleId": null,      "rate": null,      "hourlyWage": null,      "joinedAt": "2019-08-24T14:15:22Z",      "removedAt": null,      "emojis": [        "string"      ]    },    "revertedByEmployee": null,    "creatorId": "string",    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "status": "PENDING",    "price": "string",    "updatedAt": "2019-08-24T14:15:22Z",    "revertedByEmployeeId": null,    "revertedAt": null,    "mediaIds": [      "string"    ],    "scheduledAt": null,    "lastSyncedAt": null,    "createdByEmployeeId": "string",    "text": "string",    "previewIds": [      "string"    ],    "includedListIds": [      "string"    ],    "excludedListIds": [      "string"    ],    "userIds": [      "string"    ],    "includeOnlineFans": true,    "autoUnsendAfterSeconds": null,    "platformId": null,    "recipientCount": 0,    "sentCount": 0,    "canUnsend": true,    "unsendDeadline": null  },  "meta": {    "requestId": "string",    "operationId": "3051932a-fdd2-48fa-b330-7e7d41535969",    "status": "COMPLETED"  }}

List mass messages GET

List a creator's bulk message campaigns using the supported status and pagination filters.

Update mass message PATCH

Update the editable content, audience or other supported fields of an existing bulk message campaign.