Create an Extension

1 min

POST

https://api.optimizely.com/v2/extensions

Create a new Extension in a provided project

Body Parameters

bodyExtensionrequired
Description
A string in JSON format that includes all the fields to create an extension
- descriptionstring
  Description
  The description for the extension
- edit_urlstringrequired
  Description
  The URL to load when editing the extension
- enabledboolean
  Description
  Whether the extension is enabled. A disabled extension won't appear in the editor and won't be built into the snippet
- fieldsField[]
  Description
  Array of editable fields in the extension
  - api_namestringrequired
    Description
    The API name of the field
  - default_valuestringrequired
    Description
    A string in JSON format that corresponds to the default_value of the field
  - field_typestring<selector | text | multi_text | rich_text | number | html | css | js | toggle | dropdown | multi_select | image | color | slider>required
    Description
    The type of the field
    Allowed
    selectortextmulti_textrich_textnumberhtmlcssjstoggledropdownmulti_selectimagecolorslider
  - labelstringrequired
    Description
    The label of the field
  - optionsOptions
    - choicesChoices[]
      Description
      The choices for a field
      - labelstring
        Description
        label of the choice
      - valuestring
        Description
        value of the choice
- implementationImplementationrequired
  - apply_jsstring
    Description
    The Apply JS code is used to inject the extension onto the page
    Default
  - cssstring
    Description
    Some extensions may not need any CSS because they inherit styles from the page itself. However, you can add additional styling here. This will be injected on the page through a tag
    Default
  - htmlstring
    Description
    The html implementation of the field
    Default
  - reset_jsstring
    Description
    Reset JS is used to "clean up" after a extension. It's used in the editor, when changing field values or removing an existing extension. Reset JS should remove the element and any other side-effects
    Default
- namestringrequired
  Example
  My Extension
  Description
  Name of the extension
- project_idinteger<int64>required
  Example
  1000
  Description
  The project the extension is in
  Format
  int64

Responses

201Return the created extension

Extension
- archivedboolean
  Description
  Whether the extension is archived
- createdstring<date-time>
  Description
  The time when the extension was initially created
  Format
  date-time
- descriptionstring
  Description
  The description for the extension
- edit_urlstringrequired
  Description
  The URL to load when editing the extension
- enabledboolean
  Description
  Whether the extension is enabled. A disabled extension won't appear in the editor and won't be built into the snippet
- experiment_countinteger<int64>
  Example
  3
  Description
  Number of experiments that reference this extension across all statuses (running, paused, draft, archived). Computed by the upstream service.
  Format
  int64
- fieldsField[]
  Description
  Array of editable fields in the extension
  - api_namestringrequired
    Description
    The API name of the field
  - default_valuestringrequired
    Description
    A string in JSON format that corresponds to the default_value of the field
  - field_typestring<selector | text | multi_text | rich_text | number | html | css | js | toggle | dropdown | multi_select | image | color | slider>required
    Description
    The type of the field
    Allowed
    selectortextmulti_textrich_textnumberhtmlcssjstoggledropdownmulti_selectimagecolorslider
  - labelstringrequired
    Description
    The label of the field
  - optionsOptions
    - choicesChoices[]
      Description
      The choices for a field
      - labelstring
        Description
        label of the choice
      - valuestring
        Description
        value of the choice
- idinteger<int64>
  Example
  3000
  Description
  The unique identifier for the extension
  Format
  int64
- implementationImplementationrequired
  - apply_jsstring
    Description
    The Apply JS code is used to inject the extension onto the page
    Default
  - cssstring
    Description
    Some extensions may not need any CSS because they inherit styles from the page itself. However, you can add additional styling here. This will be injected on the page through a tag
    Default
  - htmlstring
    Description
    The html implementation of the field
    Default
  - reset_jsstring
    Description
    Reset JS is used to "clean up" after a extension. It's used in the editor, when changing field values or removing an existing extension. Reset JS should remove the element and any other side-effects
    Default
- last_modifiedstring<date-time>
  Description
  The last time when the extension was modified
  Format
  date-time
- namestringrequired
  Example
  My Extension
  Description
  Name of the extension
- project_idinteger<int64>required
  Example
  1000
  Description
  The project the extension is in
  Format
  int64

400Invalid request body content

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

401Invalid credentials

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

403You do not have permission to create an extension under the specified project

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

defaultUnexpected error

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

curl

curl --request POST \
     --url https://api.optimizely.com/v2/extensions \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "edit_url": "",
     "fields": [
     {
     "api_name": "",
     "default_value": "",
     "field_type": "",
     "label": ""
     }
     ],
     "implementation": {},
     "name": "My Extension",
     "project_id": 1000
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var raw = JSON.stringify({
   "edit_url": "",
   "fields": [
      {
         "api_name": "",
         "default_value": "",
         "field_type": "",
         "label": ""
      }
   ],
   "implementation": {},
   "name": "My Extension",
   "project_id": 1000
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.optimizely.com/v2/extensions", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.optimizely.com/v2/extensions")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "edit_url": "",
   "fields": [
      {
         "api_name": "",
         "default_value": "",
         "field_type": "",
         "label": ""
      }
   ],
   "implementation": {},
   "name": "My Extension",
   "project_id": 1000
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.optimizely.com/v2/extensions"

payload = json.dumps({
   "edit_url": "",
   "fields": [
      {
         "api_name": "",
         "default_value": "",
         "field_type": "",
         "label": ""
      }
   ],
   "implementation": {},
   "name": "My Extension",
   "project_id": 1000
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

201

// Return the created extension
{
  "archived": false,
  "created": "",
  "description": "",
  "edit_url": "",
  "enabled": false,
  "experiment_count": 3,
  "fields": [
    {
      "api_name": "",
      "default_value": "",
      "field_type": "",
      "label": "",
      "options": {
        "choices": [
          {
            "label": "",
            "value": ""
          }
        ]
      }
    }
  ],
  "id": 3000,
  "implementation": {
    "apply_js": "",
    "css": "",
    "html": "",
    "reset_js": ""
  },
  "last_modified": "",
  "name": "My Extension",
  "project_id": 1000
}

400

// Invalid request body content
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

401

// Invalid credentials
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

403

// You do not have permission to create an extension under the specified project
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

default

// Unexpected error
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}