Broadcasts

Create a broadcast

Creates a broadcast draft in the authenticated workspace.

post/v1/broadcasts

Request

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

Headers

Idempotency-Keystring

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

Request body

subjectstring required

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

Broadcast created

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.