1. REST API for Oracle Eloqua Marketing Cloud Service
  2. Tasks
  3. Application
  4. 1.0
  5. Option lists

Update an option list

put

/api/REST/1.0/assets/optionList/{id}

Updates the option list specified by the id parameter. All properties should be included in PUT requests, as some properties will be considered blank if not included.

Request

Supported Media Types
Path Parameters
Body ()
The request body defines the details of the option list to be updated.
Root Schema : OptionList
Type: object
Title: OptionList
Show Source
  • Read Only: true
    Unix timestamp for the date and time the option list was created.
  • Read Only: true
    The login id of the user who created the option list.
  • The option list's current status.
  • Read Only: true
    Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.
  • The description of the option list.
  • elements
    A list of option elements.
  • Read Only: true
    The option list's unique identifier.
  • The name of the option list.
  • The permissions for the option list granted to your current instance. This is a read-only property.
  • The option list's type in Eloqua. This is a read-only property.
  • Read Only: true
    Unix timestamp for the date and time the option list was last updated.
  • Read Only: true
    The login id of the user that last updated the option list.
Nested Schema : elements
Type: array
A list of option elements.
Show Source
Nested Schema : Option
Type: object
Title: Option
Show Source
  • The display name for the option that is displayed within the option list.
  • The asset's type in Eloqua. This is a read-only property. This asset is an "Option".
  • The option's internal value. This value is not displayed externally.
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : OptionList
Type: object
Title: OptionList
Show Source
  • Read Only: true
    Unix timestamp for the date and time the option list was created.
  • Read Only: true
    The login id of the user who created the option list.
  • The option list's current status.
  • Read Only: true
    Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.
  • The description of the option list.
  • elements
    A list of option elements.
  • Read Only: true
    The option list's unique identifier.
  • The name of the option list.
  • The permissions for the option list granted to your current instance. This is a read-only property.
  • The option list's type in Eloqua. This is a read-only property.
  • Read Only: true
    Unix timestamp for the date and time the option list was last updated.
  • Read Only: true
    The login id of the user that last updated the option list.
Nested Schema : elements
Type: array
A list of option elements.
Show Source
Nested Schema : Option
Type: object
Title: Option
Show Source
  • The display name for the option that is displayed within the option list.
  • The asset's type in Eloqua. This is a read-only property. This asset is an "Option".
  • The option's internal value. This value is not displayed externally.

400 Response

Bad request. See Status Codes for information about other possible HTTP status codes.

401 Response

Unauthorized. See Status Codes for information about other possible HTTP status codes.

403 Response

Forbidden. See Status Codes for information about other possible HTTP status codes.

404 Response

The requested resource was not found. See Status Codes for information about other possible HTTP status codes.

500 Response

The service has encountered an error. See Status Codes for information about other possible HTTP status codes.
Back to Top

Examples

The following examples demonstrate how to update an option list using an HTTP request and cURL. For more information on requests, see API requests.

HTTP Request Example

Update the name and options of the option list with Id #23:


PUT /api/REST/1.0/assets/optionList/23
Content-Type: application/json

Request body:


{
    "id":"23",
    "name":"What is the best candy?",
    "elements":[
        {
            "type":"Option",
            "displayName":"-- Please Select --",
            "value":"no selection"
        },
        {
            "type":"Option",
            "displayName":"Chocolate",
            "value":"chocolate"
        },
        {
            "type":"Option",
            "displayName":"Licorice",
            "value":"licorice"
        },
        {
            "type":"Option",
            "displayName":"Gumdrops",
            "value":"gumdrops"
        },
        {
            "type":"Option",
            "displayName":"Peppermint",
            "value":"peppermint"
        },
        {
            "type":"Option",
            "displayName":"Caramel",
            "value":"caramel"
        },
        {
            "type":"Option",
            "displayName":"I hate candy",
            "value":"none"
        }
    ]
}

Note:

Making a PUT request to the "elements" array of an option list asset will replace the entire array. In other words, you cannot add or change any option without reproducing the entire array in the PUT request body.

Response:


{
    "type":"OptionList",
    "id":"23",
    "initialId":"23",
    "depth":"complete",
    "name":"What is the best candy?",
    "updatedAt":"1435677760",
    "updatedBy":"19",
    "elements":[
        {
            "type":"Option",
            "displayName":"-- Please Select --",
            "value":"no selection"
        },
        {
            "type":"Option",
            "displayName":"Chocolate",
            "value":"chocolate"
        },
        {
            "type":"Option",
            "displayName":"Licorice",
            "value":"licorice"
        },
        {
            "type":"Option",
            "displayName":"Gumdrops",
            "value":"gumdrops"
        },
        {
            "type":"Option",
            "displayName":"Peppermint",
            "value":"peppermint"
        },
        {
            "type":"Option",
            "displayName":"Caramel",
            "value":"caramel"
        },
        {
            "type":"Option",
            "displayName":"I hate candy",
            "value":"none"
        }
    ]
}

cURL Example

Here is the same example in cURL given an instance with the name APITest, username API.User, and POD of 3. 


curl --user "APITest\API.User" --header "Content-Type: application/json" --request PUT --data '{"id":"23","name":"What is the best candy?","elements":[{"type":"Option","displayName":"-- Please Select --","value":"no selection"},{"type":"Option","displayName":"Chocolate","value":"chocolate"},{"type":"Option","displayName":"Licorice","value":"licorice"},{"type":"Option","displayName":"Gumdrops","value":"gumdrops"},{"type":"Option","displayName":"Peppermint","value":"peppermint"},{"type":"Option","displayName":"Caramel","value":"caramel"},{"type":"Option","displayName":"I hate candy","value":"none"}]}' https://secure.p03.eloqua.com/api/REST/1.0/assets/optionList/23
Back to Top