Sign in
GenPages

Create a campaign.

A campaign holds the page template and branding that generated pages use. Create one when an integration needs its own campaign rather than reusing an existing one.

The campaign is created empty — it still needs a page design. Give it one over the API with templates/apply or pages/generate (or build one in the GenPage dashboard) and publish it. Generating pages against a campaign with no design will produce blank pages, so create-then-generate is not a complete flow on its own.

post/api/external/v1/campaigns/create

Request body

workspace_idinteger required

The workspace to create it in.

namestring nullable

A name. One is generated from the branding if omitted.

branding_idinteger nullable

Branding to apply, from the dashboard.

promptstring nullable

Used to generate a name when name is omitted.

Example request

{
  "workspace_id": 55,
  "name": "Enterprise Outreach",
  "branding_id": 7,
  "prompt": "outbound to fintech CTOs"
}

Response

campaign_idinteger
namestring
slugstring
notestring

Example response

{
  "campaign_id": 231,
  "name": "Enterprise Outreach",
  "slug": "enterprise-outreach",
  "note": "The campaign has no page design yet — apply a template (templates/apply) or generate a design (pages/generate) and publish it before generating pages."
}

Changes

Changed in 1 of the 3 revisions of this API.1