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.
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
Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.
UUID naming this intent. Retry with the same key; reuse for other input is 409.
Request body
Response
Success.
Changes
No recorded changes to this operation across all 1 revision of this API.