FMFansMetric API

Mass Messages

Update Mass Message

Edits a queue item in place. The canonical "edit a scheduled mass message" operation — change the send time, rewrite the text, swap media, or move the audience without cancelling and recreating. Cannot edit messages already delivered (isDone: true or past scheduledDate). Pass scheduledDate alone to just reschedule, or submit a full snapshot to rewrite the message — both shapes are accepted. Requires permission api_mass_messages_update.

https://public-api.fansmetric.com
PUT/v1/{account_id}/mass-messages/queue/{queue_id}
Bearer

Authorization

default
AuthorizationBearer <token>

Send your FansMetric API key as a Bearer token in the Authorization header.

In: header

Path Parameters

  • account_id*integer

    OnlyFans numeric account ID.

  • queue_id*integer

    The queue ID of the scheduled mass message to edit.

Request Body

application/json
  • textstring

    New message text. HTML accepted.

  • lockedTextboolean

    Whether the text is locked behind the paywall.

  • mediaFilesarray

    Vault media IDs to attach. Replaces the existing attachments when provided.

  • previewsarray

    Vault media IDs to surface as paywall previews.

  • pricestring

    Price in dollars. 0 for free.

  • userListsstring

    Audience list IDs to send to.

  • userIdsstring

    Explicit user IDs to send to.

  • excludedListsstring

    List IDs to exclude from the audience.

  • rfTagstring

    Release-form tag identifier.

  • rfGueststring

    Release-form guest identifier.

  • rfPartnerstring

    Release-form partner identifier.

  • giphyIdstring

    Giphy ID if the message is a GIF.

  • scheduledDatestring

    ISO timestamp for the (re)scheduled send. Pass this alone to just reschedule.

  • recommendersstring

    Recommender block, matching the Send Mass Message shape.

  • filtersstring

    Audience filters, matching the Send Mass Message shape.

Response Fields

  • data.idinteger

    Queue ID.

  • data.datestring

    Updated send/scheduled timestamp.

  • data.isReadyboolean

    Whether the queue item is ready to send.

  • data.isDoneboolean

    Whether sending has completed (always false for edits).

  • data.canUnsendboolean

    Whether the queue item can still be cancelled.

  • data.unsendSecondsinteger

    Seconds remaining in the unsend window.

  • data.hasErrorboolean

    Whether the upstream edit errored.

  • data.isCanceledboolean

    Always false for a successful edit.

  • dataobject | array

    Endpoint-specific payload. See the fields below for this route.

  • _meta._credits.usedinteger

    Credits consumed by this request (currently always 1).

  • _meta._rate_limits.limit_minuteinteger

    Maximum requests per minute for the organization.

  • _meta._rate_limits.remaining_minuteinteger

    Remaining requests in the current minute window.

  • _meta._rate_limits.limit_dayinteger

    Maximum requests per day for the organization.

  • _meta._rate_limits.remaining_dayinteger

    Remaining requests in the current day window.

curl --request PUT "https://public-api.fansmetric.com/v1/100000001/mass-messages/queue/sample_queue_id" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{ "scheduledDate": "2026-06-10T15:00:00.000Z" }'

Response

200
{
"data":{
"id":123
"date":"2026-06-10T15:00:00+00:00"
"isReady":true
"isDone":false
"total":-1
"pending":0
"canUnsend":true
"unsendSeconds":1000000
"hasError":false
"isCanceled":false
"isCouplePeopleMedia":false
}
"_meta":{
"_credits":{
"used":1
}
"_rate_limits":{
"limit_minute":1000
"remaining_minute":999
"limit_day":50000
"remaining_day":49999
}
}
}

Previous

List Mass Message Buyers

Next

Cancel Mass Message