Update mass message

curl --request PUT \
  --url https://api.ofauth.com/v2/access/mass-messages/:massMessageId \
  --header 'Content-Type: application/json' \
  --header 'apiKey: <api-key>' \
  --header 'x-connection-id: <api-key>' \
  --data '
{
  "isForwardedMessage": false,
  "text": "",
  "replyToMessageId": "<string>",
  "mediaItems": [],
  "isLockedText": false,
  "price": 0,
  "previewMediaCount": 0,
  "releaseForms": {
    "users": [],
    "partners": [],
    "guests": []
  },
  "userTags": [],
  "isMarkdown": true,
  "scheduledDate": "<string>",
  "userIds": [
    1
  ],
  "userLists": [
    1
  ],
  "subscribedAfterDate": "<string>",
  "excludeUserLists": [
    1
  ]
}
'

import requests

url = "https://api.ofauth.com/v2/access/mass-messages/:massMessageId"

payload = {
    "isForwardedMessage": False,
    "text": "",
    "replyToMessageId": "<string>",
    "mediaItems": [],
    "isLockedText": False,
    "price": 0,
    "previewMediaCount": 0,
    "releaseForms": {
        "users": [],
        "partners": [],
        "guests": []
    },
    "userTags": [],
    "isMarkdown": True,
    "scheduledDate": "<string>",
    "userIds": [1],
    "userLists": [1],
    "subscribedAfterDate": "<string>",
    "excludeUserLists": [1]
}
headers = {
    "apiKey": "<api-key>",
    "x-connection-id": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    apiKey: '<api-key>',
    'x-connection-id': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    isForwardedMessage: false,
    text: '',
    replyToMessageId: '<string>',
    mediaItems: [],
    isLockedText: false,
    price: 0,
    previewMediaCount: 0,
    releaseForms: {users: [], partners: [], guests: []},
    userTags: [],
    isMarkdown: true,
    scheduledDate: '<string>',
    userIds: [1],
    userLists: [1],
    subscribedAfterDate: '<string>',
    excludeUserLists: [1]
  })
};

fetch('https://api.ofauth.com/v2/access/mass-messages/:massMessageId', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.ofauth.com/v2/access/mass-messages/:massMessageId",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'isForwardedMessage' => false,
    'text' => '',
    'replyToMessageId' => '<string>',
    'mediaItems' => [
        
    ],
    'isLockedText' => false,
    'price' => 0,
    'previewMediaCount' => 0,
    'releaseForms' => [
        'users' => [
                
        ],
        'partners' => [
                
        ],
        'guests' => [
                
        ]
    ],
    'userTags' => [
        
    ],
    'isMarkdown' => true,
    'scheduledDate' => '<string>',
    'userIds' => [
        1
    ],
    'userLists' => [
        1
    ],
    'subscribedAfterDate' => '<string>',
    'excludeUserLists' => [
        1
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "apiKey: <api-key>",
    "x-connection-id: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.ofauth.com/v2/access/mass-messages/:massMessageId"

	payload := strings.NewReader("{\n  \"isForwardedMessage\": false,\n  \"text\": \"\",\n  \"replyToMessageId\": \"<string>\",\n  \"mediaItems\": [],\n  \"isLockedText\": false,\n  \"price\": 0,\n  \"previewMediaCount\": 0,\n  \"releaseForms\": {\n    \"users\": [],\n    \"partners\": [],\n    \"guests\": []\n  },\n  \"userTags\": [],\n  \"isMarkdown\": true,\n  \"scheduledDate\": \"<string>\",\n  \"userIds\": [\n    1\n  ],\n  \"userLists\": [\n    1\n  ],\n  \"subscribedAfterDate\": \"<string>\",\n  \"excludeUserLists\": [\n    1\n  ]\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("apiKey", "<api-key>")
	req.Header.Add("x-connection-id", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.ofauth.com/v2/access/mass-messages/:massMessageId")
  .header("apiKey", "<api-key>")
  .header("x-connection-id", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"isForwardedMessage\": false,\n  \"text\": \"\",\n  \"replyToMessageId\": \"<string>\",\n  \"mediaItems\": [],\n  \"isLockedText\": false,\n  \"price\": 0,\n  \"previewMediaCount\": 0,\n  \"releaseForms\": {\n    \"users\": [],\n    \"partners\": [],\n    \"guests\": []\n  },\n  \"userTags\": [],\n  \"isMarkdown\": true,\n  \"scheduledDate\": \"<string>\",\n  \"userIds\": [\n    1\n  ],\n  \"userLists\": [\n    1\n  ],\n  \"subscribedAfterDate\": \"<string>\",\n  \"excludeUserLists\": [\n    1\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.ofauth.com/v2/access/mass-messages/:massMessageId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["apiKey"] = '<api-key>'
request["x-connection-id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"isForwardedMessage\": false,\n  \"text\": \"\",\n  \"replyToMessageId\": \"<string>\",\n  \"mediaItems\": [],\n  \"isLockedText\": false,\n  \"price\": 0,\n  \"previewMediaCount\": 0,\n  \"releaseForms\": {\n    \"users\": [],\n    \"partners\": [],\n    \"guests\": []\n  },\n  \"userTags\": [],\n  \"isMarkdown\": true,\n  \"scheduledDate\": \"<string>\",\n  \"userIds\": [\n    1\n  ],\n  \"userLists\": [\n    1\n  ],\n  \"subscribedAfterDate\": \"<string>\",\n  \"excludeUserLists\": [\n    1\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": 123,
  "date": "<string>",
  "isReady": true,
  "isDone": true,
  "total": 123,
  "pending": 123,
  "canUnsend": true,
  "unsendSeconds": 123,
  "hasError": true,
  "isCanceled": true,
  "isCouplePeopleMedia": true
}

PUT

access

mass-messages

:massMessageId

Update mass message

curl --request PUT \
  --url https://api.ofauth.com/v2/access/mass-messages/:massMessageId \
  --header 'Content-Type: application/json' \
  --header 'apiKey: <api-key>' \
  --header 'x-connection-id: <api-key>' \
  --data '
{
  "isForwardedMessage": false,
  "text": "",
  "replyToMessageId": "<string>",
  "mediaItems": [],
  "isLockedText": false,
  "price": 0,
  "previewMediaCount": 0,
  "releaseForms": {
    "users": [],
    "partners": [],
    "guests": []
  },
  "userTags": [],
  "isMarkdown": true,
  "scheduledDate": "<string>",
  "userIds": [
    1
  ],
  "userLists": [
    1
  ],
  "subscribedAfterDate": "<string>",
  "excludeUserLists": [
    1
  ]
}
'

import requests

url = "https://api.ofauth.com/v2/access/mass-messages/:massMessageId"

payload = {
    "isForwardedMessage": False,
    "text": "",
    "replyToMessageId": "<string>",
    "mediaItems": [],
    "isLockedText": False,
    "price": 0,
    "previewMediaCount": 0,
    "releaseForms": {
        "users": [],
        "partners": [],
        "guests": []
    },
    "userTags": [],
    "isMarkdown": True,
    "scheduledDate": "<string>",
    "userIds": [1],
    "userLists": [1],
    "subscribedAfterDate": "<string>",
    "excludeUserLists": [1]
}
headers = {
    "apiKey": "<api-key>",
    "x-connection-id": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    apiKey: '<api-key>',
    'x-connection-id': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    isForwardedMessage: false,
    text: '',
    replyToMessageId: '<string>',
    mediaItems: [],
    isLockedText: false,
    price: 0,
    previewMediaCount: 0,
    releaseForms: {users: [], partners: [], guests: []},
    userTags: [],
    isMarkdown: true,
    scheduledDate: '<string>',
    userIds: [1],
    userLists: [1],
    subscribedAfterDate: '<string>',
    excludeUserLists: [1]
  })
};

fetch('https://api.ofauth.com/v2/access/mass-messages/:massMessageId', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.ofauth.com/v2/access/mass-messages/:massMessageId",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'isForwardedMessage' => false,
    'text' => '',
    'replyToMessageId' => '<string>',
    'mediaItems' => [
        
    ],
    'isLockedText' => false,
    'price' => 0,
    'previewMediaCount' => 0,
    'releaseForms' => [
        'users' => [
                
        ],
        'partners' => [
                
        ],
        'guests' => [
                
        ]
    ],
    'userTags' => [
        
    ],
    'isMarkdown' => true,
    'scheduledDate' => '<string>',
    'userIds' => [
        1
    ],
    'userLists' => [
        1
    ],
    'subscribedAfterDate' => '<string>',
    'excludeUserLists' => [
        1
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "apiKey: <api-key>",
    "x-connection-id: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.ofauth.com/v2/access/mass-messages/:massMessageId"

	payload := strings.NewReader("{\n  \"isForwardedMessage\": false,\n  \"text\": \"\",\n  \"replyToMessageId\": \"<string>\",\n  \"mediaItems\": [],\n  \"isLockedText\": false,\n  \"price\": 0,\n  \"previewMediaCount\": 0,\n  \"releaseForms\": {\n    \"users\": [],\n    \"partners\": [],\n    \"guests\": []\n  },\n  \"userTags\": [],\n  \"isMarkdown\": true,\n  \"scheduledDate\": \"<string>\",\n  \"userIds\": [\n    1\n  ],\n  \"userLists\": [\n    1\n  ],\n  \"subscribedAfterDate\": \"<string>\",\n  \"excludeUserLists\": [\n    1\n  ]\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("apiKey", "<api-key>")
	req.Header.Add("x-connection-id", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.ofauth.com/v2/access/mass-messages/:massMessageId")
  .header("apiKey", "<api-key>")
  .header("x-connection-id", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"isForwardedMessage\": false,\n  \"text\": \"\",\n  \"replyToMessageId\": \"<string>\",\n  \"mediaItems\": [],\n  \"isLockedText\": false,\n  \"price\": 0,\n  \"previewMediaCount\": 0,\n  \"releaseForms\": {\n    \"users\": [],\n    \"partners\": [],\n    \"guests\": []\n  },\n  \"userTags\": [],\n  \"isMarkdown\": true,\n  \"scheduledDate\": \"<string>\",\n  \"userIds\": [\n    1\n  ],\n  \"userLists\": [\n    1\n  ],\n  \"subscribedAfterDate\": \"<string>\",\n  \"excludeUserLists\": [\n    1\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.ofauth.com/v2/access/mass-messages/:massMessageId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["apiKey"] = '<api-key>'
request["x-connection-id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"isForwardedMessage\": false,\n  \"text\": \"\",\n  \"replyToMessageId\": \"<string>\",\n  \"mediaItems\": [],\n  \"isLockedText\": false,\n  \"price\": 0,\n  \"previewMediaCount\": 0,\n  \"releaseForms\": {\n    \"users\": [],\n    \"partners\": [],\n    \"guests\": []\n  },\n  \"userTags\": [],\n  \"isMarkdown\": true,\n  \"scheduledDate\": \"<string>\",\n  \"userIds\": [\n    1\n  ],\n  \"userLists\": [\n    1\n  ],\n  \"subscribedAfterDate\": \"<string>\",\n  \"excludeUserLists\": [\n    1\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": 123,
  "date": "<string>",
  "isReady": true,
  "isDone": true,
  "total": 123,
  "pending": 123,
  "canUnsend": true,
  "unsendSeconds": 123,
  "hasError": true,
  "isCanceled": true,
  "isCouplePeopleMedia": true
}

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

Body

application/json

isForwardedMessage

boolean | null

default:false

Whether this is a forwarded message

text

string

default:""

Text content. Supports markdown by default. See Text Formatting Guide.

Maximum string length: 10000

replyToMessageId

string | null

Reply to an existing chat message

Minimum string length: 1

mediaItems

(integer | string)[]

Media references to attach. Accepts vault media IDs, upload references (mediaUploadId), or http(s) URLs. See mediaItems reference.

OnlyFans media ID

Required range: x > 0

isLockedText

boolean | null

default:false

Whether text is locked behind paywall (defaults to false).

price

number | null

default:0

Price to unlock message content (0 for free)

Required range: 0 <= x <= 200

previewMediaCount

integer | null

default:0

How many items in mediaItems should be previews. Uses the first N items from left to right.

Required range: x >= 0

releaseForms

object

Release form participants

Show child attributes

userTags

integer[]

Users to tag

OnlyFans user ID

Required range: x > 0

isMarkdown

boolean | null

default:true

Whether to parse text as markdown (default: true). See Text Formatting Guide.

scheduledDate

When to send the message (omit for immediate)

userIds

(integer | string)[]

Specific user IDs to send to

OnlyFans user ID

Required range: x > 0

userLists

(integer | string)[]

User list IDs to send to

OnlyFans user ID

Required range: x > 0

subscribedAfterDate

Only send to users subscribed after this date

excludeUserLists

(integer | string)[]

User list IDs to exclude

OnlyFans user ID

Required range: x > 0

Response

Successful response

number

required

date

string

required

isReady

boolean

isDone

boolean

total

number

pending

number

canUnsend

boolean

unsendSeconds

number

hasError

boolean

isCanceled

boolean

isCouplePeopleMedia

boolean

Create mass message

Delete scheduled mass message

Account API

Link API

Access API

Vault+ API

Realtime OnlyFans Events

System Webhook Events

Dynamic Rules API

Update mass message

Authorizations

Path Parameters

Body

Response