beehiiv Developer Documentation

{
  "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": "Shared across every publication",
    "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.

Retrieve a single workspace post template, including the settings posts built from it start with.

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.

Path parameters

postTemplateIdstringRequiredformat: "^(post_template_[0-9a-fA-F\-]+)$"

The prefixed ID of the post template object

Response

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error