Skip to main content
DELETE
/
v2
/
access
/
mass-messages
/
scheduled
/
:massMessageId
Delete scheduled mass message
curl --request DELETE \
  --url https://api.ofauth.com/v2/access/mass-messages/scheduled/:massMessageId \
  --header 'apiKey: <api-key>' \
  --header 'x-connection-id: <api-key>'
{
  "success": true,
  "queue": {
    "id": 123,
    "text": "<string>",
    "fromUser": {
      "id": 123,
      "name": "<string>"
    },
    "media": [
      {
        "id": 123,
        "convertedToVideo": true,
        "canView": true,
        "hasError": true,
        "createdAt": "<string>",
        "isReady": true,
        "releaseForms": [
          {
            "id": 123,
            "name": "<string>",
            "partnerSource": "<string>",
            "type": "<string>",
            "user": {
              "view": "<string>",
              "id": 123,
              "name": "<string>",
              "username": "<string>",
              "isVerified": true,
              "avatar": "<string>",
              "avatarThumbs": {
                "c50": "<string>",
                "c144": "<string>"
              },
              "ivStatus": "<string>",
              "isFromGuest": true
            }
          }
        ],
        "duration": 123,
        "hasCustomPreview": true,
        "videoSources": {
          "240": "<string>",
          "720": "<string>"
        },
        "files": {
          "full": {
            "url": "<string>",
            "sources": [
              {
                "url": "<string>",
                "width": 123,
                "height": 123,
                "type": "<string>"
              }
            ],
            "width": 123,
            "height": 123,
            "size": 123
          },
          "thumb": {
            "url": "<string>",
            "width": 123,
            "height": 123,
            "size": 123
          },
          "preview": {
            "url": "<string>",
            "options": [
              {
                "url": "<string>",
                "width": 123,
                "height": 123,
                "type": "<string>"
              }
            ],
            "width": 123,
            "height": 123,
            "size": 123
          },
          "squarePreview": {
            "url": "<string>",
            "width": 123,
            "height": 123,
            "size": 123
          }
        }
      }
    ],
    "previews": [
      123
    ],
    "isMediaReady": true,
    "mediaCount": 123,
    "lockedText": true,
    "responseType": "<string>",
    "giphyId": "<string>",
    "isFree": true,
    "isTip": true,
    "isReportedByMe": true,
    "isCouplePeopleMedia": true,
    "queueId": 123,
    "isMarkdownDisabled": true,
    "releaseForms": null,
    "isFromQueue": true,
    "canUnsendQueue": true,
    "unsendSecondsQueue": 123,
    "isOpened": true,
    "isNew": true,
    "createdAt": "<string>",
    "changedAt": "<string>",
    "cancelSeconds": 123,
    "isLiked": true,
    "canPurchase": true,
    "canPurchaseReason": "<string>",
    "canReport": true,
    "canBePinned": true,
    "isPinned": true,
    "replyToMessage": {
      "id": 123,
      "text": "<string>",
      "fromUser": {
        "id": 123,
        "name": "<string>"
      },
      "media": [
        {
          "id": 123,
          "convertedToVideo": true,
          "canView": true,
          "hasError": true,
          "createdAt": "<string>",
          "isReady": true,
          "releaseForms": [
            {
              "id": 123,
              "name": "<string>",
              "partnerSource": "<string>",
              "type": "<string>",
              "user": {
                "view": "<string>",
                "id": 123,
                "name": "<string>",
                "username": "<string>",
                "isVerified": true,
                "avatar": "<string>",
                "avatarThumbs": {
                  "c50": "<string>",
                  "c144": "<string>"
                },
                "ivStatus": "<string>",
                "isFromGuest": true
              }
            }
          ],
          "duration": 123,
          "hasCustomPreview": true,
          "videoSources": {
            "240": "<string>",
            "720": "<string>"
          },
          "files": {
            "full": {
              "url": "<string>",
              "sources": [
                {
                  "url": "<string>",
                  "width": 123,
                  "height": 123,
                  "type": "<string>"
                }
              ],
              "width": 123,
              "height": 123,
              "size": 123
            },
            "thumb": {
              "url": "<string>",
              "width": 123,
              "height": 123,
              "size": 123
            },
            "preview": {
              "url": "<string>",
              "options": [
                {
                  "url": "<string>",
                  "width": 123,
                  "height": 123,
                  "type": "<string>"
                }
              ],
              "width": 123,
              "height": 123,
              "size": 123
            },
            "squarePreview": {
              "url": "<string>",
              "width": 123,
              "height": 123,
              "size": 123
            }
          }
        }
      ],
      "previews": [
        123
      ],
      "isMediaReady": true,
      "mediaCount": 123,
      "lockedText": true,
      "responseType": "<string>",
      "giphyId": "<string>",
      "isFree": true,
      "isTip": true,
      "isReportedByMe": true,
      "isCouplePeopleMedia": true,
      "queueId": 123,
      "isMarkdownDisabled": true,
      "releaseForms": null,
      "isFromQueue": true,
      "canUnsendQueue": true,
      "unsendSecondsQueue": 123,
      "isOpened": true,
      "isNew": true,
      "createdAt": "<string>",
      "changedAt": "<string>",
      "cancelSeconds": 123,
      "isLiked": true,
      "canPurchase": true,
      "canPurchaseReason": "<string>",
      "canReport": true,
      "canBePinned": true,
      "isPinned": true
    },
    "date": "<string>",
    "textCropped": "<string>",
    "sentCount": 123,
    "viewedCount": 123,
    "canUnsend": true,
    "unsendSeconds": 123,
    "isCanceled": true,
    "mediaTypes": {
      "video": 123,
      "photo": 123,
      "gif": 123,
      "audio": 123
    },
    "hasError": true,
    "price": "<string>",
    "purchasedCount": 123,
    "canSendMessageToBuyers": true
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.ofauth.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

apiKey
string
header
required

Your OFAuth API key for authenticating requests.

x-connection-id
string
header
required

Requires a connection via the x-connection-id header.

Path Parameters

massMessageId
string
required

Response

Successful response

success
boolean
required
queue
object