discovery

Update campaign settings

Deprecated: use discovery.campaign-settings.update.v2 (discovery_campaign_settings_update_v2), which takes no audience, targetedGroupIds or removeCustomersOutsideAudience: a campaign's audiences are fixed at launch. This version still changes them. Save a Discovery campaign's settings in place, all or nothing: its name, assistants, customers (who and how many), audiences and a store campaign's stores. Results continue on the same campaign and take in the change over its next 30 days; changes reach the next run, and a run under way finishes on what it reserved. Nothing is charged at Save: delivered conversations accrue against the plan. Pass expectedSettingsRevision from discovery.campaign-settings.get; a Save whose settings moved since is refused (STALE_WRITE). Pass reviewedEstimate from discovery.campaign-settings-quotes.get to also refuse one whose estimate moved, or null to save at the current estimate. The website never changes. A person confirms it.

post/api/v1/discovery/campaign-settings/update

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/discovery/campaign-settings/update
  • 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.

Point11-Confirm'true' required

Explicit human confirmation of this operation's effect.

Request body

campaignIdstring uuid required

The campaign's id.

expectedSettingsRevisioninteger required

The settingsRevision the settings read (or a quote) returned.

Response

Success.

campaignIdstring uuid required
changedboolean required

False when the Save asked for the settings the campaign has.

settingsRevisioninteger required

The campaign's revision now.

Changes

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