Skip to main content
POST
/
v4
/
broadcasts
Create a broadcast
curl --request POST \
  --url https://api.kit.com/v4/broadcasts \
  --header 'Content-Type: application/json' \
  --header 'X-Kit-Api-Key: <api-key>' \
  --data '
{
  "email_template_id": 2,
  "email_address": null,
  "content": "<p>Let me introduce myself</p>",
  "description": "Intro email",
  "public": true,
  "published_at": "2023-02-17T11:43:55+00:00",
  "send_at": null,
  "thumbnail_alt": null,
  "thumbnail_url": null,
  "preview_text": "Pleased to meet you!",
  "subject": "Hello!",
  "subscriber_filter": [
    {
      "all": [
        {
          "type": "segment",
          "ids": [
            18
          ]
        }
      ],
      "any": null,
      "none": null
    }
  ]
}
'
{
  "broadcast": {
    "id": 27,
    "publication_id": 27,
    "created_at": "2023-02-17T11:43:55Z",
    "subject": "Hello!",
    "preview_text": "Pleased to meet you!",
    "description": "Intro email",
    "content": "<p>Let me introduce myself</p>",
    "public": true,
    "published_at": "2023-02-17T11:43:55Z",
    "send_at": null,
    "thumbnail_alt": null,
    "thumbnail_url": null,
    "public_url": "https://kit-greetings.kit.com/posts/",
    "email_address": "[email protected]",
    "email_template": {
      "id": 2,
      "name": "Classic"
    },
    "subscriber_filter": [
      {
        "all": [
          {
            "type": "segment",
            "ids": [
              18
            ]
          }
        ]
      }
    ]
  }
}

Authorizations

​
X-Kit-Api-Key
string
header
required

Authenticate API requests via an API Key

Body

application/json
​
content
string
required

The HTML content of the email.

​
description
string
required
​
public
boolean
required

true to publish this broadcast to the web. The broadcast will appear in a newsletter feed on your Creator Profile and Landing Pages.

​
published_at
string
required

The published timestamp to display in ISO8601 format. If no timezone is provided, UTC is assumed.

​
preview_text
string
required
​
subject
string
required
​
subscriber_filter
object[]
required

Filters your subscribers. At this time, we only support using only one filter group type via the API (e.g. all, any, or none but no combinations). If nothing is provided, will default to all of your subscribers.

​
email_template_id
integer

Id of the email template to use. Uses the account's default template if not provided. 'Starting point' template is not supported.

​
email_address
string | null

The sending email address to use. Uses the account's sending email address if not provided.

​
send_at
string | null

The scheduled send time for this broadcast in ISO8601 format. If no timezone is provided, UTC is assumed.

​
thumbnail_alt
string | null
​
thumbnail_url
string | null

Response

Creates a new broadcast

​
broadcast
object
required