Update a Campaign

patch

https://api.optimizely.com/v2/campaigns/{campaign_id}

Update a campaign's metadata.

Path Params

campaign_id

int64

required

The Campaign ID of the Campaign you want to change

Query Params

action

string

enum

Action to change the state of the Campaign. 'publish' publishes your campaign, making any changes live to the world without changing the status of the campaign. 'start' publishes your campaign, making any changes live to the world. Status will be 'running'. 'pause' stops the campaign. Status will be 'paused'. No new visitors will see the campaign until it is resumed. 'resume' resumes the campaign from a paused status without publishing any new changes. Status will be 'running'. 'unarchive' unarchives an archived campaign. Status will be 'paused'.

Allowed:

Body Params

A string in JSON format that includes all the fields you'd like to change for a Campaign

changes

array of objects

A list of changes to apply to the Campaign

changes

description

string

The description or goal for a Campaign

experiment_priorities

array of arrays of int64s

A list of lists of Experiment IDs that indicate the relative priority of how to show those Experiments in the context of the Campaign. Each list inside of the list represents a group of Experiments of equal priority where groups that appear earlier in the list are of higher priority to be shown.

experiment_priorities

for_journey

boolean

Defaults to false

Whether the Campaign has been part of journey or not

holdback

integer

0 to 10000

Percentage of visitors to exclude from personalization, measured in basis points. 100 basis points = 1% traffic. For example, a value of 500 would mean that 95% of visitors will see a personalized experience and 5% will see the holdback.

journey_id

string

The journey this campaign is associated with, or null if not set

metrics

array of objects

An ordered list of metrics to track for the Campaign

metrics

name

string

The name of the Campaign

page_ids

array of int64s

A list of Page IDs used in the Campaign. Only url_targeting or page_ids can be used when updating a Campaign, but not both.

page_ids

url_targeting

object

Responses

200Return the updated Campaign

400Invalid ID supplied

401Invalid credentials

403You do not have permission to edit the specified Campaign

404Campaign not found

defaultUnexpected error