Skip to main content
Roadmap items are the core of ClickFlow’s content pipeline. Each item represents a piece of content — from initial planning through AI drafting to CMS publication.

platform.create_roadmap_item

Create a new content roadmap item. Optionally start the AI drafting workflow immediately.

Parameters

NameTypeRequiredDefaultDescription
keywordstringYesTarget keyword for the content
promptstringNo""Content brief or instructions for the AI
strategystringNo"Article"Content type: Article, Listicle, How-to guide, Case study, News post, Review, Comparison, FAQ
scheduled_datestringNo""Publication date in ISO format (e.g. 2026-03-25)
start_draftingbooleanNofalseStart the AI drafting workflow immediately
image_generationstringNo""Image style: stock_photos, diagrams, illustrations, watercolor
delivery_modestringNo"draft"draft (save to roadmap item) or cms (publish to CMS on completion)
cms_connection_idstringNo""Required when delivery_mode is cms

Response

Without start_drafting:
{
  "roadmap_item_id": "ri_abc123",
  "status": "ready for review"
}
With start_drafting: true:
{
  "roadmap_item_id": "ri_abc123",
  "workflow_id": "wf_xyz789",
  "status": "In Progress",
  "message": "Roadmap item created and drafting started. Poll workflows.get_status for progress."
}

Usage

{
  "keyword": "best CRM for startups",
  "prompt": "Write a comparison for bootstrapped founders",
  "strategy": "Comparison",
  "start_drafting": true
}

platform.list_roadmap_items

List all roadmap items, optionally filtered by status.

Parameters

NameTypeRequiredDefaultDescription
statusstringNo""Filter: ready for review, approved, scheduled, drafted, synced, archived

Response

{
  "items": [
    {
      "_id": "ri_abc123",
      "keyword": "best CRM for startups",
      "status": "drafted",
      "title": "Best CRM for Startups in 2026",
      "workflowId": "wf_xyz789"
    }
  ],
  "count": 1
}

Usage

{ "status": "drafted" }

platform.get_roadmap_item

Get a single roadmap item with full details including draft HTML content.

Parameters

NameTypeRequiredDescription
roadmap_item_idstringYesThe roadmap item ID

Response

{
  "_id": "ri_abc123",
  "keyword": "best CRM for startups",
  "status": "drafted",
  "title": "Best CRM for Startups in 2026",
  "draft": {
    "title": "Best CRM for Startups in 2026",
    "html": "<h1>Best CRM for Startups</h1>...",
    "metaDescription": "Compare the top CRM tools...",
    "thumbnailUrl": "https://storage.googleapis.com/...",
    "generatedAt": 1711324800000
  },
  "workflowId": "wf_xyz789",
  "organizationId": "org_abc123"
}

Usage

{ "roadmap_item_id": "ri_abc123" }

platform.update_roadmap_item

Update a roadmap item’s metadata. Only provided fields are updated.

Parameters

NameTypeRequiredDescription
roadmap_item_idstringYesThe roadmap item ID
titlestringNoNew title
meta_descriptionstringNoNew meta description
slugstringNoNew URL slug

Response

{ "success": true }

Usage

{
  "roadmap_item_id": "ri_abc123",
  "title": "Updated Title",
  "meta_description": "Updated description for SEO"
}

platform.update_roadmap_item_status

Change the status of a roadmap item.

Parameters

NameTypeRequiredDescription
roadmap_item_idstringYesThe roadmap item ID
statusstringYesready for review, approved, changes requested, drafted, synced, archived

Response

{ "success": true }

Usage

{ "roadmap_item_id": "ri_abc123", "status": "approved" }

platform.schedule_roadmap_item

Set or change the scheduled publication date.

Parameters

NameTypeRequiredDescription
roadmap_item_idstringYesThe roadmap item ID
datestringYesISO date format (e.g. 2026-03-25)

Response

{ "success": true }

Usage

{ "roadmap_item_id": "ri_abc123", "date": "2026-04-15" }

platform.save_draft

Save or replace the full draft content on a roadmap item. Sets status to drafted.

Parameters

NameTypeRequiredDescription
roadmap_item_idstringYesThe roadmap item ID
titlestringYesDraft title
htmlstringYesFull HTML content body
meta_descriptionstringNoSEO meta description
thumbnail_urlstringNoFeatured image URL

Response

{ "success": true }

Usage

{
  "roadmap_item_id": "ri_abc123",
  "title": "My Custom Article",
  "html": "<h1>My Custom Article</h1><p>Content goes here...</p>",
  "meta_description": "A brief summary for search engines"
}

platform.publish_to_cms

Publish a roadmap item’s draft to your connected CMS. Supported CMS: WordPress, Sanity, HubSpot, Shopify, Strapi.

Parameters

NameTypeRequiredDescription
roadmap_item_idstringYesThe roadmap item ID (must have a draft)
cms_connection_idstringNoCMS connection to use. If omitted, ClickFlow resolves automatically: previous publish connection > linked workflow connection > first available CMS.

Response

{
  "success": true,
  "post_id": "12345",
  "permalink": "https://example.com/blog/my-article",
  "edit_url": "https://example.com/wp-admin/post.php?post=12345",
  "cms_type": "wordpress"
}

Errors

ErrorCause
"Roadmap item has no draft content to publish"No draft saved yet
"No CMS connection found"No CMS connected in ClickFlow dashboard

Usage

{ "roadmap_item_id": "ri_abc123" }

platform.add_target_keyword

Add a keyword to your organization’s tracking list.

Parameters

NameTypeRequiredDefaultDescription
keywordstringYesThe keyword to track
volumeintegerNo0Monthly search volume
difficultyintegerNo0Keyword difficulty (0-100)
intentstringNo"informational"informational, commercial, transactional, navigational

Response

{
  "keyword": "best CRM for startups",
  "status": "added"
}

Usage

{
  "keyword": "best CRM for startups",
  "volume": 8100,
  "difficulty": 58,
  "intent": "commercial"
}