POST /fields/{id}/choices

1 min

POST

https://api.cmp.optimizely.com/v3/fields/{id}/choices

Experimental Create choices in a field.

Path Parameters

idstringrequired
Example
8a7f910551b00a722e0418830cee6612
Description
Unique identifier of the field

Body Parameters

bodySettingsFieldChoiceCreateRequestrequired
Description
Payload to create new choices in the field

Responses

201

All the choices of the field, including the newly created ones

SettingsFieldChoiceCreateResponse
Description
Choices of the field
- idstringrequired
  Example
  6ceee2f4fa3411ecb37802420ac8001b
  Description
  Identifier of the choice
- namestringrequired
  Example
  Choice 1
  Description
  Name of the choice
- is_activebooleanrequired
  Example
  true
  Description
  Indicates active status of the choice. Inactive choices stay on the field. In the app, users cannot select them.

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/{id}/choices \
     --header 'accept: application/json'

javascript

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

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

fetch("https://api.cmp.optimizely.com/v3/fields/{id}/choices", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "net/http"

url = URI("https://api.cmp.optimizely.com/v3/fields/{id}/choices")

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

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"

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

python

import requests

url = "https://api.cmp.optimizely.com/v3/fields/{id}/choices"

payload = {}
headers = {
   'accept': 'application/json'
}

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

print(response.text)

201

// All the choices of the field, including the newly created ones
[
  {
    "id": "6ceee2f4fa3411ecb37802420ac8001b",
    "name": "Choice 1",
    "is_active": true
  }
]

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": ""
}