COconvertflow
Campaigns

Update a campaign

Updates name, format, landing-page/SEO fields, experiment settings and remix instructions. Changing cta_type republishes the campaign script immediately (and takes a landing page offline); every other field is saved without publishing. Requires campaigns:write.

patch/api/v1/campaigns/{id}

Request

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

Request body

namestring
cta_type'page' | 'overlay' | 'hook' | 'bar' | 'inline'
test_typestring
page_pathstring
domain_idinteger
meta_titlestring
meta_descriptionstring
open_graph_titlestring
open_graph_descriptionstring
open_graph_imagestring
seo_indexboolean
experiment_start_datestring date-time
experiment_end_datestring date-time
experiment_metricstring

Response

format change republishes and resets the format subtype

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.