Skip to navigation
API ReferencePost Templates

Create post template OAuth Scope: posts:write

Available on the Pro and Enterprise plans

This endpoint is available to publications on the Pro and Enterprise plans.

Create a post template for a specific publication. Posts created from the template start with its content and settings.

Content is optional: a template created without blocks or body_content starts with an empty body. Provide one or the other, never both.

Authentication

AuthorizationBearer

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

Path parameters

publicationIdstringRequiredformat: "^(pub_[0-9a-fA-F\-]+)$"
The prefixed ID of the publication object

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. Supports the same block types as Create Post, with the exception of advertisement: an advertisement opportunity is booked for a single send and cannot be stored on a template.

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 — use inline styles for all visual styling.

thumbnail_image_urlstringOptional
The URL of the thumbnail image to download for the template.
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:
content_tagslist of stringsOptional
The content tags posts built from this template start with. Tags that do not exist on the publication are created.
guest_author_idslist of stringsOptional
The prefixed IDs of the guest authors posts built from this template start with. Guest authors must belong to the publication.
team_author_idslist of stringsOptional
The prefixed IDs of the team members posts built from this template start with as authors. Team authors must have access to the publication.
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.
newsletter_list_idstringOptional
The prefixed ID of the newsletter list posts built from this template are associated with.
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
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error