Create workspace post template <Badge intent="info" minimal outlined>OAuth Scope: posts:write</Badge>

POST

https://api.beehiiv.com/v2/workspaces/post_templates

POST

/v2/workspaces/post_templates

curl -X POST https://api.beehiiv.com/v2/workspaces/post_templates \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "Workspace announcement"
}'

{
  "data": {
    "id": "post_template_00000000-0000-0000-0000-000000000000",
    "name": "Workspace announcement",
    "created": 1700000000,
    "updated": 1700000000,
    "email_settings": {
      "display_title_in_email": true,
      "display_byline_in_email": false,
      "display_subtitle_in_email": true,
      "email_header_engagement_buttons": null,
      "email_header_social_share": null,
      "email_preview_text": null,
      "email_subject_line": null,
      "sender_name": null
    },
    "web_settings": {
      "title": null,
      "subtitle": null,
      "display_title_on_web": true,
      "display_subtitle_on_web": true,
      "display_thumbnail_on_web": false
    },
    "description": null,
    "headers": null,
    "utm_source": null,
    "utm_medium": null,
    "utm_campaign": null,
    "utm_params_enabled": null
  }
}

Currently in beta

This feature is currently in beta and the API is subject to change.

Available on the Max and Enterprise plans

This endpoint is available to workspaces on the Max and Enterprise plans.

Create a post template that belongs to the workspace, so every publication in the workspace can start a post from it.

A workspace template holds only what does not depend on a publication. Newsletter lists, sending addresses, paywalls, content tags, authors and thumbnails belong to a single publication and are not accepted. Blocks that need a publication (automated_advertisement_placement, embed_link, paywall_break, poll, programmatic_ads_logo and rss), condition sets in visibility_settings, and button blocks with a relative href are refused. As on every post template, advertisement blocks are refused too.

Requires an API key with access to every publication in the workspace.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

namestringRequired

The name of the post template.

descriptionstringOptional

The description of the post template.

blockslist of objectsOptional

The structured content blocks posts built from this template start with. Blocks that need a publication are refused; see the endpoint description.

body_contentstringOptional

The content posts built from this template start with, as a single raw HTML string. The HTML is wrapped in an htmlSnippet block internally. Note that <style> and <link> tags are removed during sanitization, so use inline styles for all visual styling.

social_shareenumOptional

The social share style posts built from this template start with.

Allowed values:

email_capture_type_overrideenumOptional

The email capture type posts built from this template start with.

Allowed values:

headersmap from strings to optional stringsOptional

Custom email headers posts built from this template start with. Set a value to null to suppress a header inherited from the newsletter list or publication. System-managed headers (e.g. List-Unsubscribe, X-SMTPAPI) cannot be overridden.

utm_sourcestringOptional

The utm_source appended to links in posts built from this template.

utm_mediumstringOptional

The utm_medium appended to links in posts built from this template.

utm_campaignstringOptional

The utm_campaign appended to links in posts built from this template.

utm_params_enabledbooleanOptional

Whether UTM parameters are appended to links in posts built from this template. Omit to inherit from the newsletter list, then the publication.

email_settingsobjectOptional

The email settings posts built from this template start with.

web_settingsobjectOptional

The web settings posts built from this template start with.

Response

Created

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error