Broadcasts

Send a broadcast now

Immediately creates durable preparation for a broadcast draft or scheduled send. Mailrith calculates the exact Subscriber total and checks provider readiness in the background before delivery. A 202 response means the durable send was accepted, not that provider delivery is complete. Reuse the same idempotency key if the response is lost.

post/v1/broadcasts/{broadcast_id}/send

Request

  • Base URL: https://api.mailrith.com
  • URL: https://api.mailrith.com/v1/broadcasts/{broadcast_id}/send
  • Auth: HTTP bearer

Path parameters

broadcast_idstring required

The broadcast identifier.

Headers

Idempotency-Keystring

Optional idempotency key to retry the request safely. It must not exceed 256 UTF-8 bytes.

Request body

preflight_proofstring

Optional unchanged short-lived send_proof returned by a recent diagnostic preflight. A valid proof can seed its checked estimate. If it is omitted, expired, or no longer matches, Mailrith still creates the run immediately and calculates the exact total during durable preparation.

Response

Broadcast send started or is waiting for an earlier active Broadcast to finish

Example response

{
  "data": {
    "resource": {
      "audience_definition": {
        "match": "all",
        "groups": [
          {
            "id": "active-subscribers",
            "match": "all",
            "conditions": [
              {
                "id": "active-status",
                "field": "subscriber_status",
                "operator": "is",
                "value": [
                  "Active"
                ]
              }
            ]
          }
        ]
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.