PUT /campaigns/{campaign_id}/fields/{field_id}

1 min

PUT

https://api.cmp.optimizely.com/v3/campaigns/{campaign_id}/fields/{field_id}

Experimental Update the field value of a campaign.

Path Parameters

campaign_idstringrequired
Example
5f857f30e1c4a2038d6179e9
Description
Unique identifier of the campaign
field_idstringrequired
Example
4f857f30e1c4a2038d6179e7
Description
Unique identifier of the field of the campaign

Body Parameters

bodyCampaignFieldUpdateRequestrequired
Description
Payload to update the field value
- objectStringTypeObjectFieldUpdatePayload
  - typestringrequired
    Example
    checkbox
    Description
    Type of the field
  - valuesobject[]required
    Description
    Values for the campaign field
  - valuesstring[]
    Description
    Any single string
- objectMultiChoiceTypeObjectFieldUpdatePayload
  - typestringrequired
    Example
    checkbox
    Description
    Type of the field
  - valuesobject[]required
    Description
    Values for the campaign field
  - valuesstring[]
    Description
    Array of choice IDs
- objectDropdownTypeObjectFieldUpdatePayload
  - typestringrequired
    Example
    checkbox
    Description
    Type of the field
  - valuesobject[]required
    Description
    Values for the campaign field
  - valuesstring[]
    Description
    Array of choice ID. Multiple choice values are not acceptable for is_multi_select=false.
- objectRadioButtonTypeObjectFieldUpdatePayload
  - typestringrequired
    Example
    checkbox
    Description
    Type of the field
  - valuesobject[]required
    Description
    Values for the campaign field
  - valuesstring[]
    Description
    Accepts a single choice Id.
- objectNumberTypeObjectFieldUpdatePayload
  - typestringrequired
    Example
    checkbox
    Description
    Type of the field
  - valuesobject[]required
    Description
    Values for the campaign field
  - valuesnumber[]
    Description
    Accepts a single numeric value
- objectDateTypeObjectFieldUpdatePayload
  - typestringrequired
    Example
    checkbox
    Description
    Type of the field
  - valuesobject[]required
    Description
    Values for the campaign field
  - valuesstring[]
    Description
    Array of date-time values, in ISO 8601 UTC format (2020-02-10T10:40
    )
- objectAssetTypeObjectFieldUpdatePayload
  - typestringrequired
    Example
    checkbox
    Description
    Type of the field
  - valuesobject[]required
    Description
    Values for the campaign field
  - valuesobject[]
    Description
    Payload for fields with attachments
    - titlestringrequired
      Example
      Sample.jpeg
      Description
      Title of the image or video
      Min Length
      1
    - keystringrequired
      Example
      ce8995aea58b11ea8cd90242ac120005
      Description
      Unique identifier of the file upload session. This is the upload_meta_fields.key field retrieved from the /v3/upload-url endpoint.

Responses

200Updated the campaign field

CampaignFieldUpdateResponse
- idstringrequired
  Example
  5a7f910511b0a72230ce6631
  Description
  Unique identifier for the field
- namestringrequired
  Example
  Image Field
  Description
  Name of the field
- typeCampaignFieldTypesrequired
  Example
  image
  Description
  Type of the field
- valuesstring[]required
  Example
```
[
  "1nu8ue9wf8u9nusd9u"
]
```
  Description
  List of values selected or from user input
- linksobjectrequired
  Description
  Meta links
  - campaign_fieldsstringrequired
    Example
    https://api.cmp.optimizely.com/v3/campaigns/5f857f30e1c4a2038d6179e9/fields
    Description
    URL of the campaign fields
  - campaignstringrequired
    Example
    https://api.cmp.optimizely.com/v3/campaigns/5f857f30e1c4a2038d6179e9
    Description
    URL of the campaign

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

curl

curl --request PUT \
     --url https://api.cmp.optimizely.com/v3/campaigns/{campaign_id}/fields/{field_id} \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "type": "checkbox",
     "values": []
     }'

javascript

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

var raw = JSON.stringify({
   "type": "checkbox",
   "values": []
});

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

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

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": "checkbox",
   "values": []
})

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

python

import requests
import json

url = "https://api.cmp.optimizely.com/v3/campaigns/{campaign_id}/fields/{field_id}"

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

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

print(response.text)

200

// Updated the campaign field
{
  "id": "5a7f910511b0a72230ce6631",
  "name": "Image Field",
  "type": "image",
  "values": [
    "1nu8ue9wf8u9nusd9u"
  ],
  "links": {
    "campaign_fields": "https://api.cmp.optimizely.com/v3/campaigns/5f857f30e1c4a2038d6179e9/fields",
    "campaign": "https://api.cmp.optimizely.com/v3/campaigns/5f857f30e1c4a2038d6179e9"
  }
}

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