experience

Start campaigns (v4)

Start an always-on Experience campaign over chosen customers (or, with follows, a share of a Discovery campaign's customers, as Bootup's Experience chooses them, which the campaign records and re-reads each run: a customer who left that campaign leaves, and a store its customers no longer cover lends its share, up to 100; while that campaign is archived its customers stay until it is restored, and once it is deleted, for good; or every customer at chosen stores, dealt one per store until 100, chosen once at launch: the business profile's stores by locationKeys, stores picked on Google Maps by locationContexts, or both) and pages (or one connected app version on one mobile device), on chosen devices, shopped by Point11's shopper or the agents named, each its vendor's model in Point11's browser, as its own visit. It shops its whole grid now; once accepted, a prorated share shops again over the rest of the UTC month, then every customer monthly, on the business's published hours; a first run with no delivered visit starts none. With competitorSourceCampaignId (a Discovery campaign on its profile), each run also shops every brand the customer's latest settled conversation there labelled a direct competitor, re-read each run, uncapped. Subscribes nothing: runs use the allowance (and pay-as-you-go, if on). Returns the campaign and its launch entry; runs dispatch soon. A Google Maps pick the profile has no customers at yet is set up first, as a Discovery campaign sets up a store (verified, researched as a store and given the customers a Discovery campaign samples at each store, a one-time customer-generation charge experience_campaigns_prescreen_v2 quotes): it then answers delivery setting_up_stores with the campaign id, and the campaign commits once the setup settles and shops its share of every store's customers, leaving out any store that could not be set up; the member who started it is emailed when a store was left out or the campaign could not start. A retry under the same Idempotency-Key answers what the setup became: still setting up, the campaign it committed, or, for a setup that ended without one, a conflict whose details.setupOutcome names how it ended; another body under that key is an idempotency conflict. iPhone Safari launches only with stores that already have customers. API keys name only stores that already have customers.

post/api/v1/experience/campaigns/start-v4

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/experience/campaigns/start-v4
  • Auth: one of:
    • HTTP bearer
    • 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

campaignNamestring required
browserDevicesstring[]

The devices every customer shops each page on, each once; each device's visit is one experience run. Absent, desktop and mobile. A nativeApp names mobile alone.

agentsstring[]

The agents that shop every customer on every page and device, each once (1 to 5). point11 is Point11's own shopper; dots (OpenAI Dots), spark (Gemini Spark), muse (Meta Muse) and grok_bot (Grok Bot) each run the model that vendor's agent most likely uses, in Point11's browser, never as the real agent. Each agent's visit is one experience run at the same price. Absent, point11 alone. A settings Save changes them from the next cycle.

businessProfileIdstring uuid required
customerIdsstring[]

The customers who visit: at least one, and as many as the launch's 1,000 visits hold (each customer visits every page on every device with every agent). Not with follows or stores (locationKeys, locationContexts), which choose them.

locationKeysstring[]

Instead of customerIds or follows, the business profile's stores whose customers visit (1 to 100): each a location key business_store_profile_summaries_get_v1 lists under businessProfileId; a key that is not one of its stores now is refused. At the launch, every customer at them the launch admits, dealt one per store in the profile's store order until 100, as a followed local Discovery campaign's share is at 1 in 1. They are chosen once and become the campaign's customers; nothing of the stores is recorded.

destinationUrlsstring[] required
objectivestring required
competitorSourceCampaignIdstring uuid

A Discovery campaign on the same business profile (discovery_campaigns_list_v1's businessProfileId). Each run, every customer also shops every brand its latest settled conversation there labelled a direct competitor; a customer with none shops the pages alone. Set at launch, never changed. Public websites only: not with connectionAccess or nativeApp.

Response

Success.

campaignIdstring uuid required

The campaign: committed when delivery is dispatching; while its stores are set up, the campaign the launch commits once they settle, absent from every campaign read until then, and named by this id for the same Idempotency-Key ever after.

delivery'dispatching' | 'setting_up_stores' required

dispatching: the grid is committed and its units enter Billing's door after the response. setting_up_stores: stores the launch names have no customers yet; each is verified on Google Maps, researched and given its customers, then the campaign commits and shops, any store that could not be set up left out. The member who started it is emailed when a store was left out or the campaign could not start. Nothing is committed until then; a retry under the same Idempotency-Key answers what the setup became.

campaignKeystring nullable required

The committed campaign's key; null while setting up stores.

entryIdstring nullable required

The campaign entry this request started; read its progress with campaigns.campaign-entries.get.v1.

runUnitCountinteger nullable required

The units the grid committed; null while setting up stores.

storeCountinteger nullable required

How many stores are being set up; null when dispatching.

generatedCustomerCountinteger nullable required

How many customers their setup generates, 97 at each store as a Discovery campaign's store, a one-time customer-generation charge; null when dispatching.

Changes

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