Docswrite supports the following parameters for creating or updating a blog post or page on WordPress.
Google Docs Template
Use this Google Docs Template (opens in a new tab) to create your blog post.
The template includes all the supported features of Docswrite. You will notice we have a special docswrite_settings table at the top of the document. This table is used to configure the export settings for your blog post.
Parameters for WordPress Blog Post/Page Creation or Update
All the parameters are supported in the following ways:
- in the
docswrite_settingstable at the top of the document. Check this Google Docs Template (opens in a new tab) - in our Zapier integration (see Zapier Integration for more details)
- via our REST API (see REST API for more details)
General Parameters
| Parameter | Required | Description |
|---|---|---|
google_docs_url | Yes | URL of the Google Doc containing the blog post content. Must be shared with "anyone with link." |
title | No | Title of the blog post. Defaults to Google Docs title if not provided. |
slug | No | Custom slug for the blog post. Auto-generated if not provided. |
tags | No | Comma-separated list of tags. New tags will be created if they don't exist. |
categories | No | Comma-separated list of categories. New categories will be created if they don't exist. |
state | No | State of the blog post (publish or draft). Defaults to draft. |
author | No | Username or full name of the author. Defaults to API token creator. |
date | No | Schedule post for a future date in YYYY-MM-DD HH:MM:SS format. |
excerpt | No | Excerpt for SEO meta description. |
post_type | No | Type of the blog post (post or page). Defaults to post. |
featured_image_url | No | URL of the featured image. |
featured_image_alt_text | No | Alt text for the featured image. |
featured_image_caption | No | Caption for the featured image. |
Export Settings (export_settings)
| Parameter | Default | Description |
|---|---|---|
compress_images | true | Compress images before upload. |
demote_headings | false | Demote headings by one level. |
convert_to_webp | true | Convert images to WebP format. |
first_image_as_featured_image | true | Set the first image as the featured image. |
add_no_follow_to_external_links | true | Add nofollow attribute to external links. |
bold_as_strong | false | Convert bold text to strong tag. |
wp_content_editor | classic | pass classic or gutenberg_editor to choose which content editor to use |
Plugin-Specific Settings
Newspack Settings (newspack_settings)
| Parameter | Description |
|---|---|
newspack_article_summary | Article summary for Newspack. |
newspack_article_summary_title | Article summary title for Newspack. |
newspack_post_subtitle | Post subtitle for Newspack. |
To use Yoast & Rank Math SEO features, download and install our WordPress Plugin.
Yoast Settings (yoast_settings)
| Parameter | Description |
|---|---|
yoast_focuskw | Yoast focus keyword. |
yoast_metadesc | Yoast meta description. |
yoast_title | Yoast title. |
yoast_canonical | Yoast canonical URL. |
RankMath Settings (rankmath_settings)
| Parameter | Description |
|---|---|
rank_math_focus_keyword | RankMath focus keyword. |
ACF Settings (acf_)
| Parameter | Description |
|---|---|
acf_field_name | value name - support URL for images . |