Broadcasts

Unschedule a broadcast

Returns a scheduled Broadcast to draft state before delivery starts.

delete/v1/broadcasts/{broadcast_id}/schedule

Request

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

Path parameters

broadcast_idstring required

The broadcast identifier.

Response

Broadcast returned to draft

Example response

{
  "data": {
    "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.