Check Mass DM Lists

curl --request POST \
  --url https://studio-api.onlytraffic.com/api/external/v1/shoutouts/pools/{uuid}/check-lists \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "send_to": [
    "Fans",
    "Following"
  ],
  "exclude_lists": [
    "*NO MASS*",
    "*ALT LEAD*"
  ],
  "refresh": false
}
'

import requests

url = "https://studio-api.onlytraffic.com/api/external/v1/shoutouts/pools/{uuid}/check-lists"

payload = {
    "send_to": ["Fans", "Following"],
    "exclude_lists": ["*NO MASS*", "*ALT LEAD*"],
    "refresh": False
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    send_to: ['Fans', 'Following'],
    exclude_lists: ['*NO MASS*', '*ALT LEAD*'],
    refresh: false
  })
};

fetch('https://studio-api.onlytraffic.com/api/external/v1/shoutouts/pools/{uuid}/check-lists', 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://studio-api.onlytraffic.com/api/external/v1/shoutouts/pools/{uuid}/check-lists",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'send_to' => [
        'Fans',
        'Following'
    ],
    'exclude_lists' => [
        '*NO MASS*',
        '*ALT LEAD*'
    ],
    'refresh' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <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://studio-api.onlytraffic.com/api/external/v1/shoutouts/pools/{uuid}/check-lists"

	payload := strings.NewReader("{\n  \"send_to\": [\n    \"Fans\",\n    \"Following\"\n  ],\n  \"exclude_lists\": [\n    \"*NO MASS*\",\n    \"*ALT LEAD*\"\n  ],\n  \"refresh\": false\n}")

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

	req.Header.Add("X-API-Key", "<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.post("https://studio-api.onlytraffic.com/api/external/v1/shoutouts/pools/{uuid}/check-lists")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"send_to\": [\n    \"Fans\",\n    \"Following\"\n  ],\n  \"exclude_lists\": [\n    \"*NO MASS*\",\n    \"*ALT LEAD*\"\n  ],\n  \"refresh\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://studio-api.onlytraffic.com/api/external/v1/shoutouts/pools/{uuid}/check-lists")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"send_to\": [\n    \"Fans\",\n    \"Following\"\n  ],\n  \"exclude_lists\": [\n    \"*NO MASS*\",\n    \"*ALT LEAD*\"\n  ],\n  \"refresh\": false\n}"

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

{
  "success": true,
  "data": {
    "pool_id": "550e8400-e29b-41d4-a716-446655440000",
    "send_to": [
      "Fans",
      "Following"
    ],
    "exclude_lists": [
      "*NO MASS*"
    ],
    "checked_at": "2026-09-21T19:58:00Z",
    "checked_at_ts": 1790020680,
    "reach": 318968,
    "reach_complete": true,
    "truncated": false,
    "publishers": [
      {
        "account": {
          "of_account_id": 123456,
          "username": "mymodel",
          "session_status": "active",
          "creatives": {
            "story": 123,
            "post": 123,
            "bio": 123,
            "mass_dm": 123
          },
          "pools": [
            {
              "pool_id": "550e8400-e29b-41d4-a716-446655440000",
              "name": "<string>",
              "status": "active",
              "role": "host"
            }
          ]
        },
        "ok": true,
        "error": "host_no_access",
        "audience": 78585,
        "lists_updated_at": "2026-09-22T09:12:00Z",
        "lists_updated_at_ts": 1790068320,
        "send_to": {
          "found": [
            {
              "name": "⛔️NO MASS⛔️",
              "fans": 38,
              "matched": true
            }
          ],
          "missing": [
            "*ALT LEAD*"
          ]
        },
        "exclude": {
          "found": [
            {
              "name": "⛔️NO MASS⛔️",
              "fans": 38,
              "matched": true
            }
          ],
          "missing": [
            "*ALT LEAD*"
          ]
        },
        "similar": {
          "send_to": {},
          "exclude": {}
        }
      }
    ],
    "missing": [
      {
        "name": "*ALT LEAD*",
        "side": "send_to",
        "publishers": 5,
        "similar": [
          {
            "name": "📤Alt Lead📤",
            "publishers": 4
          }
        ]
      }
    ]
  }
}

{
  "success": false,
  "error": "validation_failed",
  "message": "<string>",
  "details": {},
  "retry_after": 123
}

{
  "success": false,
  "error": "validation_failed",
  "message": "<string>",
  "details": {},
  "retry_after": 123
}

{
  "success": false,
  "error": "validation_failed",
  "message": "<string>",
  "details": {},
  "retry_after": 123
}

{
  "success": false,
  "error": "validation_failed",
  "message": "<string>",
  "details": {},
  "retry_after": 123
}

{
  "success": false,
  "error": "validation_failed",
  "message": "<string>",
  "details": {},
  "retry_after": 123
}

POST

shoutouts

pools

{uuid}

check-lists

Check Mass DM Lists

curl --request POST \
  --url https://studio-api.onlytraffic.com/api/external/v1/shoutouts/pools/{uuid}/check-lists \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "send_to": [
    "Fans",
    "Following"
  ],
  "exclude_lists": [
    "*NO MASS*",
    "*ALT LEAD*"
  ],
  "refresh": false
}
'

import requests

url = "https://studio-api.onlytraffic.com/api/external/v1/shoutouts/pools/{uuid}/check-lists"

payload = {
    "send_to": ["Fans", "Following"],
    "exclude_lists": ["*NO MASS*", "*ALT LEAD*"],
    "refresh": False
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    send_to: ['Fans', 'Following'],
    exclude_lists: ['*NO MASS*', '*ALT LEAD*'],
    refresh: false
  })
};

fetch('https://studio-api.onlytraffic.com/api/external/v1/shoutouts/pools/{uuid}/check-lists', 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://studio-api.onlytraffic.com/api/external/v1/shoutouts/pools/{uuid}/check-lists",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'send_to' => [
        'Fans',
        'Following'
    ],
    'exclude_lists' => [
        '*NO MASS*',
        '*ALT LEAD*'
    ],
    'refresh' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <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://studio-api.onlytraffic.com/api/external/v1/shoutouts/pools/{uuid}/check-lists"

	payload := strings.NewReader("{\n  \"send_to\": [\n    \"Fans\",\n    \"Following\"\n  ],\n  \"exclude_lists\": [\n    \"*NO MASS*\",\n    \"*ALT LEAD*\"\n  ],\n  \"refresh\": false\n}")

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

	req.Header.Add("X-API-Key", "<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.post("https://studio-api.onlytraffic.com/api/external/v1/shoutouts/pools/{uuid}/check-lists")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"send_to\": [\n    \"Fans\",\n    \"Following\"\n  ],\n  \"exclude_lists\": [\n    \"*NO MASS*\",\n    \"*ALT LEAD*\"\n  ],\n  \"refresh\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://studio-api.onlytraffic.com/api/external/v1/shoutouts/pools/{uuid}/check-lists")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"send_to\": [\n    \"Fans\",\n    \"Following\"\n  ],\n  \"exclude_lists\": [\n    \"*NO MASS*\",\n    \"*ALT LEAD*\"\n  ],\n  \"refresh\": false\n}"

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

{
  "success": true,
  "data": {
    "pool_id": "550e8400-e29b-41d4-a716-446655440000",
    "send_to": [
      "Fans",
      "Following"
    ],
    "exclude_lists": [
      "*NO MASS*"
    ],
    "checked_at": "2026-09-21T19:58:00Z",
    "checked_at_ts": 1790020680,
    "reach": 318968,
    "reach_complete": true,
    "truncated": false,
    "publishers": [
      {
        "account": {
          "of_account_id": 123456,
          "username": "mymodel",
          "session_status": "active",
          "creatives": {
            "story": 123,
            "post": 123,
            "bio": 123,
            "mass_dm": 123
          },
          "pools": [
            {
              "pool_id": "550e8400-e29b-41d4-a716-446655440000",
              "name": "<string>",
              "status": "active",
              "role": "host"
            }
          ]
        },
        "ok": true,
        "error": "host_no_access",
        "audience": 78585,
        "lists_updated_at": "2026-09-22T09:12:00Z",
        "lists_updated_at_ts": 1790068320,
        "send_to": {
          "found": [
            {
              "name": "⛔️NO MASS⛔️",
              "fans": 38,
              "matched": true
            }
          ],
          "missing": [
            "*ALT LEAD*"
          ]
        },
        "exclude": {
          "found": [
            {
              "name": "⛔️NO MASS⛔️",
              "fans": 38,
              "matched": true
            }
          ],
          "missing": [
            "*ALT LEAD*"
          ]
        },
        "similar": {
          "send_to": {},
          "exclude": {}
        }
      }
    ],
    "missing": [
      {
        "name": "*ALT LEAD*",
        "side": "send_to",
        "publishers": 5,
        "similar": [
          {
            "name": "📤Alt Lead📤",
            "publishers": 4
          }
        ]
      }
    ]
  }
}

{
  "success": false,
  "error": "validation_failed",
  "message": "<string>",
  "details": {},
  "retry_after": 123
}

{
  "success": false,
  "error": "validation_failed",
  "message": "<string>",
  "details": {},
  "retry_after": 123
}

{
  "success": false,
  "error": "validation_failed",
  "message": "<string>",
  "details": {},
  "retry_after": 123
}

{
  "success": false,
  "error": "validation_failed",
  "message": "<string>",
  "details": {},
  "retry_after": 123
}

{
  "success": false,
  "error": "validation_failed",
  "message": "<string>",
  "details": {},
  "retry_after": 123
}

Resolves the pool’s Mass DM audience on every publisher the way a send would: send_to and exclude_lists names are looked up on each page by letters and digits only (emoji, punctuation, spacing and case are ignored; * stands for any characters in exclusions). Per publisher the answer lists the lists found with their sizes, the names that matched nothing with the closest lists that page has, and audience: the fans the message reaches after the found exclusions. reach sums the audiences that were counted and reach_complete says whether every publisher answered (a publisher whose counter failed keeps its lists but has audience null); missing collects every name that matched nothing on at least one publisher, most misses first, with the closest names across pages. Similar lists come per side; one flagged matched is already covered by another name of that side and needs no action there. Pass send_to or exclude_lists in the body to try other names without changing the pool. A missing exclude list does not stop a send: the engine sends without it and marks the placement with the notice exclude_missing, so fix the names before the next mailing. Lists come from the parser’s stored copy while it is fresh (refreshed hourly and at every send; lists_updated_at says when), refresh: true re-reads them from OnlyFans first; the audience counter is always live. One check covers the first 30 publishers of the pool (truncated says whether more exist). Takes a few seconds.

Authorizations

X-API-Key

string

header

required

Your API key from the Studio Dashboard

Path Parameters

uuid

string<uuid>

required

Pool id: the pool_id value from the pools list.

Body

application/json

send_to

string[]

List names to try instead of the pool's send_to; the pool is not changed.

Maximum array length: 20

Maximum string length: 50

Example:

["Fans", "Following"]

exclude_lists

string[]

Names or * patterns to try instead of the pool's exclude_lists; the pool is not changed.

Maximum array length: 20

Maximum string length: 50

Example:

["*NO MASS*", "*ALT LEAD*"]

refresh

boolean

default:false

true re-reads every publisher's lists from OnlyFans before matching; otherwise the parser's stored copy is used while it is fresh (it is refreshed hourly and at every send)

Response

Successful response

success

boolean

Example:

true

data

object

Show child attributes

Overview

Platforms

Work Formats

Tools

Payments & Safety

API & MCP

Check Mass DM Lists

Authorizations

Path Parameters

Body

Response