Campaigns

Create a campaign

Creates a campaign. Without template_id: a blank campaign with a single "Champion" variant at 100% traffic, answered 201. With template_id (from GET /api/v1/templates): the campaign row is created right away (archived, building: true, no variants) and answered 202 while a job copies the template content and runs the AI remix when remix.remix_all_text asks for it; the campaign unarchives itself and building flips to false when the job finishes. A failed job leaves it archived with building: false and build_failed: true, and campaign mutations answer 422 while building is true. name and cta_type default to the template's. Popups, hooks, bars and embeds are not live on creation; a landing page is live once it exists and is not archived. page_path defaults to page-{id}. Requires campaigns:write.

post/api/v1/campaigns

Request

  • Base URL
    https://app.convertflow.co
  • Auth
    HTTP bearer

Request body

namestring

Required unless template_id is given

cta_type'page' | 'overlay' | 'hook' | 'bar' | 'inline'

Campaign format, required unless template_id is given

test_typestring
page_pathstring

Landing page path (unique per website and domain)

domain_idinteger
template_idinteger

Template to build from (GET /api/v1/templates); answers 202

Response

campaign created

idinteger
namestring
cta_typestring

Campaign format

format_typestring nullable

Campaign sub-format. Null for page and bar campaigns, which have none.

archivedboolean
liveboolean

Whether visitors can reach the campaign: the live toggle for popups, hooks, bars and embeds; not archived for landing pages.

buildingboolean
build_failedboolean
test_typestring
page_pathstring
domain_idunknown
meta_titleunknown
meta_descriptionunknown
open_graph_titleunknown
open_graph_descriptionunknown
open_graph_imageunknown
seo_indexunknown
experiment_start_dateunknown
experiment_end_dateunknown
experiment_metricunknown
published_atunknown
created_atstring date-time
updated_atstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.