discovery

Launch campaigns

Deprecated: use discovery.campaigns.launch.v2 (discovery_campaigns_launch_v2), which takes no replacesCampaignId: a campaign's settings change in place with discovery.campaign-settings.update.v2, so this version refuses a replacesCampaignId (PRECONDITION_FAILED, details.reason use_campaign_settings) and otherwise launches exactly as v2, naming the same campaign for the same Idempotency-Key. Start a Discovery campaign for a website or an existing business profile (url may be null when businessProfileId is supplied), for an organization whose Analytics subscription already admits work and whose payment method is on file. Its conversations accrue against the organization's Analytics plan as they run. This never subscribes, applies an offer, or asks for a card: an organization without an active subscription or saved payment method is refused and subscribes in the Point11 dashboard first. Returns the campaign; its setup runs in the background.

post/api/v1/discovery/campaigns/launch

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/discovery/campaigns/launch
  • Auth: OAuth 2 (authorization code, authorization URL https://auth.point11.ai/oauth2/authorize, token URL https://auth.point11.ai/oauth2/token)

Headers

Point11-Organizationstring uuid

Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.

Idempotency-Keystring uuid required

UUID naming this intent. Retry with the same key; reuse for other input is 409.

Request body

expectedMonthlyPriceCentsinteger

The Analytics monthly price the caller reviewed, in cents; a launch whose current price differs is refused (reason PRICE_CHANGED).

replacesCampaignIdstring uuid

Refused: a campaign's settings change in place with discovery.campaign-settings.update.v2. Omit it to start a new campaign.

Response

Accepted: the durable run started. Follow it with GET /api/v1/platform/runs-v2/{id}.

runIdstring nullable required

The billing run the launch dispatched, or null: campaign setup is a background workflow, not a billing run, and bills its conversations as they are admitted.

status'setup_started' required

setup_started: the campaign exists and its setup runs in the background (a retry of a launch already started answers the same).

campaignIdstring uuid required

The started campaign. Its first entry is admitted once its setup finishes, after this response; list its entries with campaigns.campaign-entries.list.v1.

Changes

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