COconvertflow
Campaigns

Archive a campaign

Archives the campaign: it stops being served (an empty script is published) and its quick broadcast is set inactive. Reversible with POST /campaigns/{id}/unarchive. Campaigns are never deleted through the API. Requires campaigns:write.

post/api/v1/campaigns/{id}/archive

Request

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

Response

campaign archived

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
remixobject
published_atunknown
created_atstring date-time
updated_atstring date-time

Changes

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