FOforem
billboards

Preview a billboard

Changed on

Render a billboard's Markdown/HTML copy into processed_html and minimized_processed_html without saving it.

post/api/billboards/preview

Request

  • Base URL
    https://dev.to
  • Auth
    • API key in header api-key
    • or HTTP bearer

Request body

body_markdownstring

The text (in markdown or raw HTML) of the ad

minimized_body_markdownstring nullable

Optional minimized markdown copy

placement_area'sidebar_left' | 'sidebar_left_2' | 'sidebar_right' | 'sidebar_right_second' | 'sidebar_right_third' | 'feed_first' | 'feed_second' | 'feed_third' | 'home_hero' | 'footer' | 'page_fixed_bottom' | 'post_fixed_bottom' | 'post_body_bottom' | 'post_body_bottom_secondary' | 'post_sidebar' | 'post_sidebar_secondary' | 'post_comments' | 'post_comments_secondary' | 'post_comments_mid' | 'digest_first' | 'digest_second' | 'external_feed' nullable
render_mode'forem_markdown' | 'raw'

Response

successful

processed_htmlstring nullable
minimized_processed_htmlstring nullable

Changes