Broadcasts

Update a broadcast

Updates an existing Broadcast draft. Scheduled, running, completed, and failed Broadcasts cannot be changed here. Before changing a scheduled Broadcast, read it by ID and retain its scheduled_at in the current task only. If the saved time is no longer safely in the future, ask the user for a new time before unscheduling. Otherwise unschedule it, apply the update, reschedule it for the same time, and verify both status and scheduled_at. If the update fails after unscheduling, restore the unchanged Broadcast to the same future time when possible. If the schedule cannot be restored, leave it as a Draft and immediately report that it will not send; never choose a replacement time without the user.

put/v1/broadcasts/{broadcast_id}

Request

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

Path parameters

broadcast_idstring required

The broadcast identifier.

Request body

subjectstring

For Subscriber personalization in email subjects and body text nodes, use Mailrith bracket tokens such as [Subscriber_Name, fallback="friend"] or [Subscriber_Email, fallback=""]. Before using a custom field, call custom_fields_list or custom_fields_get and copy its personalization_token exactly. Do not use Handlebars-style variables such as {{ subscriber.name }}; Mailrith sends them as literal text.

preview_textstring nullable

connection_idstring nullable

reply_to_emailstring nullable

track_opensboolean

track_clicksboolean

utm_sourcestring nullable

utm_mediumstring nullable

utm_campaignstring nullable

utm_termstring nullable

utm_contentstring nullable

Example request

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

Response

Successful response

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.