List the bulk emails of a site

list_site_email_bulks

Lists the bulk emails of a site, newest first, each with its status, subject, recipient counts and delivery counts.

POST /v1/list_site_email_bulksScopeconfig:readRead only

The answer carries items and nextCursor. Pass nextCursor back as cursor for the next page, and it is null once there is nothing more. get_site_email_bulk reads one with its recipients. See Follow and cancel a bulk email.

Request

Call it with a POST to https://api.modulify.ai/v1/list_site_email_bulks, 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_email_bulks \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"projectId":"PROJECT_ID"}'

Over MCP, the same method is the list_site_email_bulks tool.

Inputs

Input Type Required Description
projectId string Yes The site id.
limit number No How many bulk emails to return, 20 by default and at most 100.
cursor string No The nextCursor from the previous page. Omit it for the first 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.