Get campaign settings quotes
Deprecated: use discovery.campaign-settings-quotes.get.v2 (discovery_campaign_settings_quotes_get_v2), which takes no audience, targetedGroupIds or removeCustomersOutsideAudience: a campaign's audiences are fixed at launch. This version still quotes a change to them. Review a Save of a Discovery campaign's settings before making it, writing nothing: each change and when it starts (from the next run; a run under way finishes on what it reserved), the change in estimated monthly conversations at today's price with any one-time work, Billing's answer to the extra work, how the change reaches results, and who a lower customer count removes. Pass the settingsRevision discovery.campaign-settings.get returned as expectedSettingsRevision; refused when the settings changed since. id is the campaign's id.
Request
- Base URL: https://point11.ai
- URL: https://point11.ai/api/v1/discovery/campaign-settings-quotes/{id}
- 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)
Path parameters
Discovery campaign id.
Query parameters
The settingsRevision the settings read (or a quote) returned.
The campaign's new name.
The assistants the campaign asks from its next run: the whole set, at least one. Add, remove or swap; past conversations stay.
When an assistant is added: also run it once, within a day, for the customers this month's runs already refreshed (true when omitted), so its results are complete this month.
How many customers it runs: the campaign's total, or, on a store campaign, the customers per store. Raising it adds eligible customers, then generates the rest; lowering it removes the newest joined first unless removeCustomerIds names who leaves.
Customers to add; each joins this month's calendar.
Customers to remove; each leaves every later run at once and keeps its history.
Who can be added: every eligible customer (all) or members of targetedGroupIds (groups). It never resamples the current customers.
The audiences, with audience groups.
With a new audience: also remove the current customers outside it.
Stores to stop measuring, by key: their customers leave at once and their history stays.
Stores to add, each one JSON-encoded store pick as the update takes it.
Headers
Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.
Response
Success.
Changes
No recorded changes to this operation across all 1 revision of this API.