POST /fields

1 min

POST

https://api.cmp.optimizely.com/v3/fields

Experimental Add a new field to an Organization.

Body Parameters

bodySettingsFieldCreateRequestrequired
Description
Payload to create a new field in an Organization
- objectBaseSettingsFieldCreatePayload
  - namestringrequired
    Example
    Sample Checkbox
    Description
    Name of the field
    Min Length
    1
  - helper_textstring
    Example
    This field is used to check options
    Description
    Used to help understand the functionality of the field.
    Max Length
    120
  - is_activebooleanrequired
    Example
    true
    Description
    Indicates active status of field. Inactive fields cannot be accessed in tasks, campaigns or workflows.
  - typestringrequired
    Example
    checkbox
    Description
    Type of the field
- objectLabelTypeSettingsFieldCreatePayload
  - namestringrequired
    Example
    Sample Checkbox
    Description
    Name of the field
    Min Length
    1
  - helper_textstring
    Example
    This field is used to check options
    Description
    Used to help understand the functionality of the field.
    Max Length
    120
  - is_activebooleanrequired
    Example
    true
    Description
    Indicates active status of field. Inactive fields cannot be accessed in tasks, campaigns or workflows.
  - typestringrequired
    Example
    checkbox
    Description
    Type of the field
  - is_multi_selectbooleanrequired
    Description
    Allow users to select multiple values
  - choicesobject[]required
    Description
    Choices of the field
    - namestringrequired
      Example
      Choice 1
      Description
      Name of the choice
      Min Length
      1
    - colorstringrequired
      Example
      #FFC700
      Description
      Code of choice color. Colors are limited to the following:
      
      Electric Blue (#4ECFD5)
      
      Golden Rod (#FFC700)
      
      Salmon Pink (#FF98A7)
      
      Blue Violet (#702BD5)
      
      Spring Green (#5FEEAD)
      
      Lavender Blue (#D6C4F2)
      
      Sky (#5F9FF6)
      
      Persian blue (#CB5DEB)
      
      Cool Gray (#9694B3)
- objectDropdownTypeSettingsFieldCreatePayload
  - namestringrequired
    Example
    Sample Checkbox
    Description
    Name of the field
    Min Length
    1
  - helper_textstring
    Example
    This field is used to check options
    Description
    Used to help understand the functionality of the field.
    Max Length
    120
  - is_activebooleanrequired
    Example
    true
    Description
    Indicates active status of field. Inactive fields cannot be accessed in tasks, campaigns or workflows.
  - typestringrequired
    Example
    checkbox
    Description
    Type of the field
  - is_multi_selectbooleanrequired
    Description
    Allow users to select multiple values
  - choicesobject[]required
    Description
    Choices of the field
    - namestringrequired
      Example
      Choice 1
      Description
      Name of the choice
      Min Length
      1
- objectCheckboxAndRadioTypeSettingsFieldCreatePayload
  - namestringrequired
    Example
    Sample Checkbox
    Description
    Name of the field
    Min Length
    1
  - helper_textstring
    Example
    This field is used to check options
    Description
    Used to help understand the functionality of the field.
    Max Length
    120
  - is_activebooleanrequired
    Example
    true
    Description
    Indicates active status of field. Inactive fields cannot be accessed in tasks, campaigns or workflows.
  - typestringrequired
    Example
    checkbox
    Description
    Type of the field
  - choicesobject[]required
    Description
    Choices of the field
    - namestringrequired
      Example
      Choice 1
      Description
      Name of the choice
      Min Length
      1
- objectGenericNumberTypeSettingsFieldCreatePayload
  - namestringrequired
    Example
    Sample Checkbox
    Description
    Name of the field
    Min Length
    1
  - helper_textstring
    Example
    This field is used to check options
    Description
    Used to help understand the functionality of the field.
    Max Length
    120
  - is_activebooleanrequired
    Example
    true
    Description
    Indicates active status of field. Inactive fields cannot be accessed in tasks, campaigns or workflows.
  - typestringrequired
    Example
    checkbox
    Description
    Type of the field
  - has_thousand_separatorboolean
    Example
    true
    Description
    Whether the numerical field has a thousand separator
    Default
    false
  - decimal_placesinteger
    Example
    2
    Description
    Decimal place of the numerical field. This must be greather than 0. If this field is empty, 2 is set as the default.
    Default
    2
- objectCurrencyNumberTypeSettingsFieldCreatePayload
  - namestringrequired
    Example
    Sample Checkbox
    Description
    Name of the field
    Min Length
    1
  - helper_textstringrequired
    Example
    This field is used to check options
    Description
    Used to help understand the functionality of the field.
    Max Length
    120
  - is_activebooleanrequired
    Example
    true
  - typestringrequired
    Example
    checkbox
    Description
    Type of the field
  - has_thousand_separatorbooleanrequired
    Example
    true
    Description
    Whether the numerical field has a thousand separator
    Default
    false
  - decimal_placesintegerrequired
    Example
    2
    Default
    2
  - currency_codestring
    Example
    USD
    Description
    Currency code of the numerical field. This must be a valid currency code. If this field is empty, USD is set as the default.
    Default
    USD

Responses

201Created new field in an Organization

object
- idstringrequired
  Example
  6ceee2f4fa3411ecb37802420ac8001b
  Description
  Identifier of the field that has been created.

400Client error

Error
Example
```
{
  "message": "Unsupported arguments: a,b,c"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

401Authorization error

Error
Example
```
{
  "message": "Unauthorized"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

403Permission error

Error
Example
```
{
  "message": "You do not have the permission to perform this operation"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

404Not found error

Error
Example
```
{
  "message": "Resource not found"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

422Unprocessable entity error

Error
Example
```
{
  "message": "Resource cannot be processed"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

curl

curl --request POST \
     --url https://api.cmp.optimizely.com/v3/fields \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "name": "Sample Checkbox",
     "is_active": true,
     "type": "checkbox"
     }'

javascript

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

var raw = JSON.stringify({
   "name": "Sample Checkbox",
   "is_active": true,
   "type": "checkbox"
});

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

fetch("https://api.cmp.optimizely.com/v3/fields", 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.cmp.optimizely.com/v3/fields")

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({
   "name": "Sample Checkbox",
   "is_active": true,
   "type": "checkbox"
})

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

python

import requests
import json

url = "https://api.cmp.optimizely.com/v3/fields"

payload = json.dumps({
   "name": "Sample Checkbox",
   "is_active": True,
   "type": "checkbox"
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

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

print(response.text)

201

// Created new field in an Organization
{
  "id": "6ceee2f4fa3411ecb37802420ac8001b"
}

400

// Client error
{
  "message": "Not found",
  "errors": ""
}

401

// Authorization error
{
  "message": "Not found",
  "errors": ""
}

403

// Permission error
{
  "message": "Not found",
  "errors": ""
}

404

// Not found error
{
  "message": "Not found",
  "errors": ""
}

422

// Unprocessable entity error
{
  "message": "Not found",
  "errors": ""
}