PUT /work-requests/{work_request_id}/form-fields/{form_field_identifier}

1 min

PUT

https://api.cmp.optimizely.com/v3/work-requests/{work_request_id}/form-fields/{form_field_identifier}

Experimental Updates a work request form field.

Path Parameters

work_request_idstringrequired
Example
7674a2a69f8d4eb48e8d4dafaebc7238
Description
Unique identifier of the work request
form_field_identifierstringrequired
Example
209d2d281e2b11edbac602420ac80012
Description
Unique identifier of the work request form field

Body Parameters

bodyWorkRequestFormFieldUpdateRequestrequired
Description
Payload to update the work request form field
- objectWorkRequestRequestFormFieldBriefTypePayload
  - typestring<brief>required
    Example
    brief
    Description
    Type of the form field
    Allowed
    brief
  - valuesWorkRequestAttachmentBriefRequest[]required
    Description
    Brief value payload
    - typestring<attachment_brief>required
      Example
      attachment_brief
      Allowed
      attachment_brief
    - valueobjectrequired
      - keystringrequired
        Example
        6dzf4ds4fds4f4564dzsfd
        Description
        Unique identifier of the file upload session. This should be the value of upload_meta_fields.key retrieved using the /v3/upload-url endpoint
      - namestringrequired
        Example
        Sample-name
        Description
        Name of the attachment brief
- objectWorkRequestRequestFormFieldCheckboxTypePayload
  - typestring<checkbox>required
    Example
    checkbox
    Description
    Type of the form field
    Allowed
    checkbox
  - valuesstring[]required
    Example
    [ "63342902e84c7544973c07ce", "633429b2e84c7544973c07e7" ]
    Description
    Unique identifiers of the choices
- objectWorkRequestRequestFormFieldCurrencyNumberTypePayload
  - typestring<currency_number>required
    Example
    currency_number
    Description
    Type of the form field
    Allowed
    currency_number
  - valuesstring[]required
    Example
    [ "123.45" ]
    Description
    Currency amount for the form field
- objectWorkRequestRequestFormFieldDateTypePayload
  - typestring<date>required
    Example
    date
    Description
    Type of the form field
    Allowed
    date
  - valuesstring[]required
    Example
    [ "2022-04-30T06:00:00.00Z" ]
    Description
    Date and time, in ISO 8601 UTC format
- objectWorkRequestRequestFormFieldDropdownTypePayload
  - typestring<dropdown>required
    Example
    dropdown
    Description
    Type of the form field
    Allowed
    dropdown
  - valuesstring[]required
    Example
    [ "63342902e84c7544973c07ce" ]
    Description
    Unique identifier of the choice for the form field
- objectWorkRequestRequestFormFieldFileTypePayload
  - typestring<file>required
    Example
    file
    Description
    Type of the form field
    Allowed
    file
  - valuesobject[]required
    Example
    [ { "key": "123456/789654", "name": "My File" } ]
    Description
    uploaded file values
    - keystringrequired
      Description
      Unique identifier of the file upload session. This is the upload_meta_fields.key field was retrieved from the /v3/upload-url endpoint.
    - namestringrequired
      Description
      Name for the file
      Min Length
      1
- objectWorkRequestRequestFormFieldLabelTypePayload
  - typestring<label>required
    Example
    label
    Description
    Type of the form field
    Allowed
    label
  - valuesstring[]required
    Example
    [ "63342902e84c7544973c07ce" ]
    Description
    Unique identifiers of label values for the form field
- objectWorkRequestRequestFormFieldPercentageNumberTypePayload
  - typestring<percentage_number>required
    Example
    percentage_number
    Description
    Type of the form field
    Allowed
    percentage_number
  - valuesstring[]required
    Example
    [ "123.456" ]
    Description
    Value for the form field
- objectWorkRequestRequestFormFieldRadioButtonTypePayload
  - typestring<radio_button>required
    Example
    radio_button
    Description
    Type of the form field
    Allowed
    radio_button
  - valuesstring[]required
    Example
    [ "63342902e84c7544973c07ce" ]
    Description
    Unique identifier of the choice for the form field
- objectWorkRequestRequestFormFieldRichtextTypePayload
  - typestring<richtext>required
    Example
    richtext
    Description
    Type of the form field
    Allowed
    richtext
  - valuesstring[]required
    Example
    [ "<h1>hello world</h1>" ]
    Description
    Value of the form field
- objectWorkRequestRequestFormFieldSimpleNumberTypePayload
  - typestring<simple_number>required
    Example
    simple_number
    Description
    Type of the form field
    Allowed
    simple_number
  - valuesstring[]required
    Example
    [ "123.456" ]
    Description
    Value of the form field
- objectWorkRequestRequestFormFieldTextAreaTypePayload
  - typestring<text_area>required
    Example
    text_area
    Description
    Type of the form field
    Allowed
    text_area
  - valuesstring[]required
    Example
    [ "Hello world" ]
    Description
    Value of the form field
- objectWorkRequestRequestFormFieldTextTypePayload
  - typestring<text>required
    Example
    text
    Description
    Type of the form field
    Allowed
    text
  - valuesstring[]required
    Example
    [ "Hello world" ]
    Description
    Value of the form field

Responses

200Updated work request form field

WorkRequestRequestFormFieldUpdateResponse
- objectWorkRequestRequestFormFieldBriefTypeResponse
  - typestring<brief>required
    Example
    brief
    Description
    Type of the form field
    Allowed
    brief
  - valuesWorkRequestAttachmentBriefResponse[]required
    Description
    Brief value payload
    - typestring<attachment_brief>required
      Example
      attachment_brief
      Allowed
      attachment_brief
    - valueobjectrequired
      - idstringrequired
        Example
        6dzf4ds4fds4f4564dzsfd
        Description
        Unique identifier of the attachment brief
      - namestringrequired
        Example
        Sample-name
        Description
        Name of the attachment brief
      - urlstringrequired
        Example
        https://files.cmp.optimizely.com/download/8nv8svsdnivjusdijuvisdv?token=token
        Description
        URL of the attachment brief
- objectWorkRequestRequestFormFieldCheckboxTypeResponse
  - typestring<checkbox>required
    Example
    checkbox
    Description
    Type of the form field
    Allowed
    checkbox
  - valuesobject[]required
    Example
    [ { "id": "63342902e84c7544973c07ce", "name": "Option 1" }, { "id": "633429b2e84c7544973c07e7", "name": "Option 2" } ]
    Description
    Values for the form field
    - idstringrequired
      Description
      Unique identifier of the choice
    - namestringrequired
      Description
      Name of the choice
- objectWorkRequestRequestFormFieldCurrencyNumberTypePayload
  - typestring<currency_number>required
    Example
    currency_number
    Description
    Type of the form field
    Allowed
    currency_number
  - valuesstring[]required
    Example
    [ "123.45" ]
    Description
    Currency amount for the form field
- objectWorkRequestRequestFormFieldDateTypePayload
  - typestring<date>required
    Example
    date
    Description
    Type of the form field
    Allowed
    date
  - valuesstring[]required
    Example
    [ "2022-04-30T06:00:00.00Z" ]
    Description
    Date and time, in ISO 8601 UTC format
- objectWorkRequestRequestFormFieldDropdownTypeResponse
  - typestring<dropdown>required
    Example
    dropdown
    Description
    Type of the form field
    Allowed
    dropdown
  - valuesobject[]required
    Example
    [ { "id": "63342902e84c7544973c07ce", "name": "Option 1" } ]
    Description
    Value for the form field
    - idstringrequired
      Description
      Unique identifier of the choice
    - namestringrequired
      Description
      Name of the choice
- objectWorkRequestRequestFormFieldFileTypeResponse
  - typestring<file>required
    Example
    file
    Description
    Type of the form field
    Allowed
    file
  - valuesobject[]required
    Example
    [ { "id": "a113667245d111eb8945000c", "name": "My File", "url": "https://files.cmp.optimizely.com/download/96c314a645d111eb8945000c291b51d4?token=" } ]
    Description
    Values for the form field
    - idstringrequired
      Description
      Unique identifier of the file
    - namestringrequired
      Description
      Name for the file
      Min Length
      1
    - urlstringrequired
      Description
      Download URL of the file
- objectWorkRequestRequestFormFieldLabelTypeResponse
  - typestring<label>required
    Example
    label
    Description
    Type of the form field
    Allowed
    label
  - valuesobject[]required
    Example
    [ { "id": "63342902e84c7544973c07ce", "name": "Label 1" } ]
    Description
    Values for the form field
    - idstringrequired
      Description
      Unique identifiers of label value
    - namestringrequired
      Description
      Name of the label value
- objectWorkRequestRequestFormFieldPercentageNumberTypePayload
  - typestring<percentage_number>required
    Example
    percentage_number
    Description
    Type of the form field
    Allowed
    percentage_number
  - valuesstring[]required
    Example
    [ "123.456" ]
    Description
    Value for the form field
- objectWorkRequestRequestFormFieldRadioButtonTypeResponse
  - typestring<radio_button>required
    Example
    radio_button
    Description
    Type of the form field
    Allowed
    radio_button
  - valuesobject[]required
    Example
    [ { "id": "63342902e84c7544973c07ce", "name": "Choice 1" } ]
    Description
    Value for the form field
    - idstring
      Description
      Unique identifier of the choice
    - namestring
      Description
      Name of the choice value
- objectWorkRequestRequestFormFieldRichtextTypePayload
  - typestring<richtext>required
    Example
    richtext
    Description
    Type of the form field
    Allowed
    richtext
  - valuesstring[]required
    Example
    [ "<h1>hello world</h1>" ]
    Description
    Value of the form field
- objectWorkRequestRequestFormFieldSimpleNumberTypePayload
  - typestring<simple_number>required
    Example
    simple_number
    Description
    Type of the form field
    Allowed
    simple_number
  - valuesstring[]required
    Example
    [ "123.456" ]
    Description
    Value of the form field
- objectWorkRequestRequestFormFieldTextAreaTypePayload
  - typestring<text_area>required
    Example
    text_area
    Description
    Type of the form field
    Allowed
    text_area
  - valuesstring[]required
    Example
    [ "Hello world" ]
    Description
    Value of the form field
- objectWorkRequestRequestFormFieldTextTypePayload
  - typestring<text>required
    Example
    text
    Description
    Type of the form field
    Allowed
    text
  - valuesstring[]required
    Example
    [ "Hello world" ]
    Description
    Value of the form field

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 PUT \
     --url https://api.cmp.optimizely.com/v3/work-requests/{work_request_id}/form-fields/{form_field_identifier} \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "type": "brief",
     "values": [
     {
     "type": "attachment_brief",
     "value": {
     "key": "6dzf4ds4fds4f4564dzsfd",
     "name": "Sample-name"
     }
     }
     ]
     }'

javascript

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

var raw = JSON.stringify({
   "type": "brief",
   "values": [
      {
         "type": "attachment_brief",
         "value": {
            "key": "6dzf4ds4fds4f4564dzsfd",
            "name": "Sample-name"
         }
      }
   ]
});

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

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

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

request = Net::HTTP::Put.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "type": "brief",
   "values": [
      {
         "type": "attachment_brief",
         "value": {
            "key": "6dzf4ds4fds4f4564dzsfd",
            "name": "Sample-name"
         }
      }
   ]
})

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

python

import requests
import json

url = "https://api.cmp.optimizely.com/v3/work-requests/{work_request_id}/form-fields/{form_field_identifier}"

payload = json.dumps({
   "type": "brief",
   "values": [
      {
         "type": "attachment_brief",
         "value": {
            "key": "6dzf4ds4fds4f4564dzsfd",
            "name": "Sample-name"
         }
      }
   ]
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

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

print(response.text)

200

// Updated work request form field
{}

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