KIkit
Broadcasts

Create a broadcast

Changed on

Draft or schedule to send a broadcast to all or a subset of your subscribers.<br/><br/>To save a draft, set send_at to null.<br/><br/>To publish to the web, set public to true.<br/><br/>To schedule the broadcast for sending, provide a send_at timestamp. Scheduled broadcasts should contain a subject and your content, at a minimum.<br/><br/>We currently support targeting your subscribers based on segment or tag ids.<aside class='notice'>Starting point templates are not currently supported.</aside>

post/v4/broadcasts

Request

  • Base URL
    https://api.kit.com
  • URL
    https://api.kit.com/v4/broadcasts
  • Auth
    • API key in header X-Kit-Api-Key
    • or OAuth 2
      Authorization code: https://api.kit.com/v4/oauth/authorize
      Token URL: https://api.kit.com/v4/oauth/token

Request body

email_template_idinteger

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

email_addressstring nullable

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

contentstring required

The HTML content of the email. On a Classic template this is the body, and the template adds the design around it when the broadcast is sent. On a Starting point template the design lives in the body, so this is the complete email: keep the wrappers, images, inline styles and Liquid tags, including {{ unsubscribe_url }} and {{ address }}. Without an unsubscribe link the broadcast can't be sent.

A read returns the string that was written, so GET, PUT, GET round-trips, apart from Kit's own "Built with Kit" badge, which a Starting point write takes out of the body and re-applies when the email renders. A broadcast built in Kit's editor reads back as Kit's rendered HTML instead, and writing that back replaces its individually-editable blocks with one HTML block. Sending content in the same request as a Starting point email_template_id also needs allow_starting_point: true. Omit content and name a Starting point template in email_template_id to create the broadcast with that template's own design.

descriptionstring required
publicboolean 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_atstring required

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

send_atstring nullable

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

thumbnail_altstring nullable
thumbnail_urlstring nullable
preview_textstring required
subjectstring required

Response

Creates a new broadcast

Changes