research

Update campaign settings

Save a Research campaign's settings in place, all or nothing: its name, interview count, audience, schedule and study, from the next admission day; results continue on the same campaign, where an edited question starts fresh from its first answer after the change and every unchanged question keeps its history. Whom it interviews (its profile's customers or its stores') never changes. Nothing is charged at Save: delivered interviews accrue against the plan. Pass expectedSettingsRevision from research_campaign_settings_get_v4; a Save whose settings moved since is refused (STALE_WRITE). Pass reviewedEstimate from research_campaign_settings_quotes_get to also refuse one whose estimate moved, or null to save at the current estimate. A person confirms it.

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

Request

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