experience

Get campaign settings quotes

Review a Save of an Experience campaign's settings before making it, writing nothing: each change and when it starts (from the next cycle planned; a cycle already planned keeps what it planned), the change in estimated monthly visits at today's price, Billing's answer to the extra work and how the change reaches results. Pass the settingsRevision experience_campaign_settings_get returned as expectedSettingsRevision; refused when the settings changed since. id is the campaign's id.

get/api/v1/experience/campaign-settings-quotes/{id}

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/experience/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

idstring uuid required

The Experience campaign's id.

Query parameters

expectedSettingsRevisioninteger required

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

namestring

The campaign's new name.

browserDevicesstring[]

The devices each next cycle visits on: the whole set, at least one.

agentsstring[]

The agents that shop every next cycle, each on every customer, page and device: the whole set, at least one. point11 is Point11's own shopper; the others run the model their vendor's agent most likely uses, in Point11's browser. An added agent starts with the next cycle; a cycle already planned keeps its agents. A Mirror (Pulse) shops with point11 alone.

addCustomerIdsstring[]

Customers the next cycles also visit with.

removeCustomerIdsstring[]

Customers taken off the list: they stop at once, even in a cycle already planned, and their past visits stay.

customerVersionPolicy'pinned' | 'latest'

Every new cycle uses each customer's newest version, so latest changes nothing. pinned is no longer a choice: 409 PRECONDITION_FAILED, details.reason invalid_change, details.field customerVersionPolicy.

Headers

Point11-Organizationstring uuid

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

Response

Success.

settingsRevisioninteger required

The settings revision this quote read; pass it as expectedSettingsRevision.

requiresReviewboolean required

Whether the Save changes money or results, so Billing is asked about its work and a quoted estimate is re-checked; false when it changes only the name.

resultsNotestring nullable required

How the change reaches results; null when results do not change.

Changes

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