PATCH /projects/{project_id}
Update a Project
Servers
- https://api.optimizely.com/v2
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
project_id |
Integer | Yes |
The Project ID of the Project you want to change |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
confidence_threshold |
Number | No |
The significance level at which you would like to declare winning and losing variations. A lower number minimizes the time needed to declare a winning or losing variation, but increases the risk that your results aren't true winners and losers. The precision for this number is up to 4 decimal places. |
name |
String | No |
The name of the Project |
description |
String | No |
A short description of the Project |
status |
String | No |
The current status of the Project Valid values:
|
account_id |
Integer | No |
The ID of the account the Project is associated with |
dcp_service_id |
Integer | No |
The ID of a Dynamic Customer Profile Service associated with this Project |
web_snippet |
Object | No | |
web_snippet.visitor_id_locator_name |
String | No |
(BETA) The name of said identifier that locates the visitor id |
web_snippet.visitor_id_locator_type |
String | No |
(BETA) The type of identifer where the visitor id is located (e.g. cookies, query param) Valid values:
|
web_snippet.exclude_names |
Boolean | No |
Set to true to mask descriptive names |
web_snippet.project_javascript |
String | No |
The javascript code which runs before Optimizely on all pages, regardless of whether or not there is a running Experiment |
web_snippet.ip_anonymization |
Boolean | No |
Set to true to change the last octet of IP addresses to 0 prior to logging |
web_snippet.ip_filter |
String | No |
A regular expression (max 1500 characters) matching ip addresses for filtering out visitors. Matching visitors will still see the Experiment, but they won't be counted in results. |
web_snippet.library |
String | No |
The prefered jQuery library version you would like to use with your snippet. If you do not want to include jQuery, set include_jquery to false Valid values:
|
web_snippet.enable_force_variation |
Boolean | No |
Enables the option to force yourself into a specific variation on any page |
web_snippet.include_jquery |
Boolean | No |
Set to true to include jQuery in your snippet |
web_snippet.exclude_disabled_experiments |
Boolean | No |
Set to true to remove paused and draft Experiment from the snippet |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.