API Reference
  1. Mail API - Message Actions
  2. Message Actions

Run a bulk delivery action

post
https://{apiHost}/api-v1/bulk/delivery/

Runs the requested action on messages that match the q query.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
q
object
required

JSON object that selects the messages to preview or change. It uses the same query structure as message log searches.

Body Params
boolean

Run the action in the background.

string
enum
required

Action to run on each matching message.

Allowed:
boolean

Include per-message results in the response.

Responses

400

The query or requested action is invalid.

Updated about 3 hours ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 3 hours ago

Did this page help you?