POST /projects

Create a new Project in your account

Servers

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
is_flags_enabled Boolean No

If is_flags_enabled is true, this project uses the new Flags-First user experience and will use the Flags API to make changes to entities.

description String No

A short description of the Project

last_modified String No

The time the Project was last modified

third_party_platform String No

The third party platform with which the project is intended to be used. When this is set, a project might have special restrictions. This can have a value of "salesforce" but defaults to null. In order to set this field, an account must have the third party platforms feature and be a fullstack project.

Valid values:

  • "salesforce"
status String No

The current status of the Project

Valid values:

  • "active"
  • "archived"

Default value: "active"

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:

  • "cookie"
  • "js"
  • "localStorage"
  • "query"
web_snippet.exclude_names Boolean No

Set to true to mask descriptive names

Default value: true

web_snippet.js_file_size Integer No

The current size in bytes of the Project snippet

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

Default value: false

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:

  • "jquery-1.6.4-full"
  • "jquery-1.11.3-trim"
  • "jquery-1.11.3-full"
  • "jquery-1.6.4-trim"
  • "none"

Default value: "jquery-1.11.3-trim"

web_snippet.code_revision Integer No

The current revision number of the Project snippet

web_snippet.enable_force_variation Boolean No

Enables the option to force yourself into a specific variation on any page

Default value: false

web_snippet.include_jquery Boolean No

Set to true to include jQuery in your snippet

Default value: true

web_snippet.exclude_disabled_experiments Boolean No

Set to true to remove paused and draft Experiment from the snippet

Default value: false

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

id Integer No

The unique identifier for the Project

created String No

The time that the Project was originally created

name String Yes

The name of the Project

platform String No

The platform of the Project

Valid values:

  • "android"
  • "web"
  • "ios"
  • "custom"

Default value: "web"

socket_token String No

The token used to identify your mobile app to Optimizely (mobile only)

sdks[] Array No

For Full Stack, Mobile, and OTT projects, the language used for the SDK

account_id Integer No

The account the Project is associated with

is_classic Boolean No

If is_classic is true it means that the project doesn't have Optimizely X enabled. In other words: this project is Optimizely Classic only. The v2 REST API can only be used for Optimizely X objects (with the exception of Audiences and Projects, which can be shared between Optimizely X and Classic), so when is_classic is set to true you will need to use the v1 API

dcp_service_id Integer No

The ID of a Dynamic Customer Profile Service associated with this Project

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.