POST tasks/{task_id}/fields
1 min
POST
https://api.cmp.optimizely.com/v3/tasks/{task_id}/fields
Path Parameters
- task_idstringrequiredExampleDescription
Body Parameters
- bodyObjectFieldCreateRequestrequiredDescription
- objectStringTypeObjectField
- typestringrequiredExampleDescription
- valuesundefined[]requiredDescription
- idstringrequiredExampleDescription
- typestringrequiredExampleDescription
- valuesundefined[]requiredDescription
- objectMultiChoiceTypeObjectField
- typestringrequiredExampleDescription
- valuesundefined[]requiredDescription
- idstringrequiredExampleDescription
- typestringrequiredExampleDescription
- valuesundefined[]requiredDescription
- objectDropdownTypeObjectField
- typestringrequiredExampleDescription
- valuesundefined[]requiredDescription
- idstringrequiredExampleDescription
- typestringrequiredExampleDescription
- valuesundefined[]required
- objectRadioButtonTypeObjectField
- typestringrequiredExampleDescription
- valuesundefined[]requiredDescription
- idstringrequiredExampleDescription
- typestringrequiredExampleDescription
- valuesundefined[]requiredDescription
- objectNumberTypeObjectField
- typestringrequiredExampleDescription
- valuesundefined[]requiredDescription
- idstringrequiredExampleDescription
- typestringrequiredExampleDescription
- valuesundefined[]requiredDescription
- objectDateTypeObjectField
- typestringrequiredExampleDescription
- valuesundefined[]requiredDescription
- idstringrequiredExampleDescription
- typestringrequiredExampleDescription
- valuesundefined[]required
- objectAssetTypeObjectField
- typestringrequiredExampleDescription
- valuesundefined[]requiredDescription
- idstringrequiredExampleDescription
- typestringrequiredExampleDescription
- valuesundefined[]requiredDescription
Responses
201
- ObjectFieldCreateResponse
- objectFieldTypeCommon
- idstringrequiredExampleDescription
- namestringrequiredExampleDescription
- valuesstring[]requiredDescription
- typestringrequiredExampleDescription
- objectFieldTypeLabel
- idstringrequiredExampleDescription
- namestringrequiredExampleDescription
- valuesstring[]requiredDescription
- typestringrequiredExampleDescription
- is_multi_selectbooleanrequiredDescription
- choicesobject[]requiredDescription
- idstringrequiredExampleDescription
- namestringrequiredExampleDescription
- objectFieldTypeDropdown
- idstringrequiredExampleDescription
- namestringrequiredExampleDescription
- valuesstring[]requiredDescription
- typestringrequiredExampleDescription
- is_multi_selectbooleanrequiredDescription
- choicesobject[]requiredDescription
- idstringrequiredExampleDescription
- namestringrequiredExampleDescription
- objectFieldTypeRadio
- idstringrequiredExampleDescription
- namestringrequiredExampleDescription
- valuesstring[]requiredDescription
- typestringrequiredExampleDescription
- choicesobject[]requiredDescription
- idstringrequiredExampleDescription
- namestringrequiredExampleDescription
- objectFieldTypeCheckbox
- idstringrequiredExampleDescription
- namestringrequiredExampleDescription
- valuesstring[]requiredDescription
- typestringrequiredExampleDescription
- choicesobject[]requiredDescription
- idstringrequiredExampleDescription
- namestringrequiredExampleDescription
- objectFieldTypeSimpleNumber
- idstringrequiredExampleDescription
- namestringrequiredExampleDescription
- valuesstring[]requiredDescription
- typestringrequiredExampleDescription
- has_thousand_separatorbooleanrequiredExampleDescription
- decimal_placesintegerrequiredExampleDescription
- objectFieldTypePercentageNumber
- idstringrequiredExampleDescription
- namestringrequiredExampleDescription
- valuesstring[]requiredDescription
- typestringrequiredExampleDescription
- decimal_placesintegerrequiredExampleDescription
- objectFieldTypeCurrencyNumber
- idstringrequiredExampleDescription
- namestringrequiredExampleDescription
- valuesstring[]requiredDescription
- typestringrequiredExampleDescription
- has_thousand_separatorbooleanrequiredExampleDescription
- decimal_placesintegerrequiredExampleDescription
- currency_codestringrequiredExampleDescription
400
- ErrorExample
{ "message": "Unsupported arguments: a,b,c" }Description- messagestringrequiredExampleDescription
- errorsmap<string, string>Description
401
- ErrorExample
{ "message": "Unauthorized" }Description- messagestringrequiredExampleDescription
- errorsmap<string, string>Description
403
- ErrorExample
{ "message": "You do not have the permission to perform this operation" }Description- messagestringrequiredExampleDescription
- errorsmap<string, string>Description
404
- ErrorExample
{ "message": "Resource not found" }Description- messagestringrequiredExampleDescription
- errorsmap<string, string>Description
422
- ErrorExample
{ "message": "Resource cannot be processed" }Description- messagestringrequiredExampleDescription
- errorsmap<string, string>Description
curl
curl --request POST \
--url https://api.cmp.optimizely.com/v3/tasks/{task_id}/fields \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '{
"type": "checkbox",
"values": [],
"id": "41aac313bda1e40b6cde7116fc24a"
}'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var raw = JSON.stringify({
"type": "checkbox",
"values": [],
"id": "41aac313bda1e40b6cde7116fc24a"
});
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("https://api.cmp.optimizely.com/v3/tasks/{task_id}/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/tasks/{task_id}/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({
"type": "checkbox",
"values": [],
"id": "41aac313bda1e40b6cde7116fc24a"
})
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.cmp.optimizely.com/v3/tasks/{task_id}/fields"
payload = json.dumps({
"type": "checkbox",
"values": [],
"id": "41aac313bda1e40b6cde7116fc24a"
})
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
201
// Added field to a task.
{}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": ""
}