List blocked numbers

list_site_message_opt_outs

Lists the numbers a site never texts, from people who replied STOP to numbers blocked by hand.

POST /v1/list_site_message_opt_outsScopeconfig:readRead only

Each number has its reason, stop for a STOP reply and manual for a block by hand, and when it was added, newest first. A text to any of them is refused. Pass nextCursor back as cursor for the next page. See Blocked numbers.

Request

Call it with a POST to https://api.modulify.ai/v1/list_site_message_opt_outs, sending the inputs below as a JSON object. The token needs the config:read scope.

It only reads and changes nothing, so retrying it is safe.

curl -X POST https://api.modulify.ai/v1/list_site_message_opt_outs \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"projectId":"PROJECT_ID"}'

Over MCP, the same method is the list_site_message_opt_outs tool.

Inputs

Input Type Required Description
projectId string Yes The site id.
cursor string No nextCursor from the previous page.

Response

Every call answers with the JSON envelope of success, message, data, code and version. data holds the result described above, and on a method that returns a total, count carries it. The response headers carry the call's X-Request-Id and what is left of your per-minute budget in X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset. Errors explains every status code a call can answer with.