PATCH /fields/{id}

1 min

PATCH

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

Experimental Update a field in an Organization.

Path Parameters

idstringrequired
Example
8q7f910551b00a722e0418830cee6612
Description
Unique identifier of the field

Body Parameters

bodySettingsFieldUpdateRequestrequired
Description
Payload to update in an Organization.
- objectBaseSettingsFieldUpdatePayload
  - typestringrequired
    Description
    Type of the field. This field is required but not updateable. Type of a field will always stay the same. Update request body must contain atleast one other updateable field.
  - namestring
    Example
    Sample Field
    Description
    Name of the field
    Min Length
    1
  - helper_textstring
    Example
    This is a helper text
    Description
    Used to help understand the functionality of the field.
    Max Length
    120
  - is_activeboolean
    Example
    true
    Description
    Indicates active status of field. Inactive fields cannot be accessed in tasks, campaigns or workflows.
- objectLabelAndDropdownTypeSettingsFieldUpdatePayload
  - typestringrequired
    Description
    Type of the field. This field is required but not updateable. Type of a field will always stay the same. Update request body must contain atleast one other updateable field.
  - namestring
    Example
    Sample Field
    Description
    Name of the field
    Min Length
    1
  - helper_textstring
    Example
    This is a helper text
    Description
    Used to help understand the functionality of the field.
    Max Length
    120
  - is_activeboolean
    Example
    true
    Description
    Indicates active status of field. Inactive fields cannot be accessed in tasks, campaigns or workflows.
  - is_multi_selectboolean
    Description
    Allow users to select multiple values
- objectGenericNumberTypeSettingsFieldUpdatePayload
  - typestringrequired
    Description
    Type of the field. This field is required but not updateable. Type of a field will always stay the same. Update request body must contain atleast one other updateable field.
  - namestring
    Example
    Sample Field
    Description
    Name of the field
    Min Length
    1
  - helper_textstring
    Example
    This is a helper text
    Description
    Used to help understand the functionality of the field.
    Max Length
    120
  - is_activeboolean
    Example
    true
    Description
    Indicates active status of field. Inactive fields cannot be accessed in tasks, campaigns or workflows.
  - 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
- objectCurrencyNumberTypeSettingsFieldUpdatePayload
  - typestringrequired
    Description
    Type of the field. This field is required but not updateable. Type of a field will always stay the same. Update request body must contain atleast one other updateable field.
  - namestringrequired
    Example
    Sample Field
    Description
    Name of the field
    Min Length
    1
  - helper_textstringrequired
    Example
    This is a helper text
    Description
    Used to help understand the functionality of the field.
    Max Length
    120
  - is_activebooleanrequired
    Example
    true
  - 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

204Updated field in an Organization

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 PATCH \
     --url https://api.cmp.optimizely.com/v3/fields/{id} \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "type": ""
     }'

javascript

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

var raw = JSON.stringify({
   "type": ""
});

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

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

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

request = Net::HTTP::Patch.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "type": ""
})

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

python

import requests
import json

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

payload = json.dumps({
   "type": ""
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

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

print(response.text)

204

// Updated field in an Organization

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