Create a List Attribute

1 min

POST

https://api.optimizely.com/v2/list_attributes

Create a List Attribue with provided name, list_type and key_field. Fields description and list_content are optional.

Body Parameters

bodyListAttributerequired
Description
A string in JSON format that includes all the fields to create a new List Attribute
- archivedboolean
  Description
  Whether or not the List Attribute has been archived
  Default
  false
- descriptionstring
  Description
  A short description of the List Attribute
- key_fieldstringrequired
  Description
  The name of the object which holds targeting ids on your website
- list_contentstring
  Description
  A comma separated string of IDs or ZIP Codes. Items will be matched against the key_field to determine if an active visitor should be targeted by the list. Note that if the list currently contains data, providing this value will overwrite the previous data.
- list_typestring<cookies | query_parameters | zip_codes | js_variables>
  Description
  The type of data object which holds targeting ids on your website (cookies, query parameters, zip codes, Global JS variables)
  Allowed
  cookiesquery_parameterszip_codesjs_variables
- namestringrequired
  Example
  SubscriberStatus
  Description
  A unique, human-readable name for the List Attribute
  Pattern
  ^[-_0-9A-Za-z]+$
- project_idinteger<int64>required
  Description
  The ID of the project the List Attribute belongs to
  Format
  int64

Responses

201Successfully created the List Attribute

ListAttribute
- account_idinteger<int64>
  Description
  The unique identifier for the Optimizely account
  Format
  int64
- archivedboolean
  Description
  Whether or not the List Attribute has been archived
  Default
  false
- aws_access_keystring
  Description
  AWS access key to upload List Attribute source file to S3
- aws_secret_keystring
  Description
  AWS secret key to upload List Attribute source file to S3
- createdstring<date-time>
  Description
  Time when the List Attribute was created
  Format
  date-time
- descriptionstring
  Description
  A short description of the List Attribute
- idinteger<int64>
  Description
  The unique identifier for the List Attribute
  Format
  int64
- key_fieldstringrequired
  Description
  The name of the object which holds targeting ids on your website
- last_modifiedstring<date-time>
  Description
  The last time the List Attribute was modified
  Format
  date-time
- list_contentstring
  Description
  A comma separated string of IDs or ZIP Codes. Items will be matched against the key_field to determine if an active visitor should be targeted by the list. Note that if the list currently contains data, providing this value will overwrite the previous data.
- list_typestring<cookies | query_parameters | zip_codes | js_variables>
  Description
  The type of data object which holds targeting ids on your website (cookies, query parameters, zip codes, Global JS variables)
  Allowed
  cookiesquery_parameterszip_codesjs_variables
- namestringrequired
  Example
  SubscriberStatus
  Description
  A unique, human-readable name for the List Attribute
  Pattern
  ^[-_0-9A-Za-z]+$
- project_idinteger<int64>required
  Description
  The ID of the project the List Attribute belongs to
  Format
  int64
- s3_pathstring
  Description
  S3 path containing files used to populate the List Attribute with data. Can be used with an S3 client or CLI to upload data.

400Invalid request body content

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

401Invalid credentials

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

defaultUnexpected error

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

curl

curl --request POST \
     --url https://api.optimizely.com/v2/list_attributes \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "key_field": "",
     "name": "SubscriberStatus",
     "project_id": ""
     }'

javascript

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

var raw = JSON.stringify({
   "key_field": "",
   "name": "SubscriberStatus",
   "project_id": ""
});

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

fetch("https://api.optimizely.com/v2/list_attributes", 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.optimizely.com/v2/list_attributes")

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({
   "key_field": "",
   "name": "SubscriberStatus",
   "project_id": ""
})

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

python

import requests
import json

url = "https://api.optimizely.com/v2/list_attributes"

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

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

print(response.text)

201

// Successfully created the List Attribute
{
  "account_id": "",
  "archived": false,
  "aws_access_key": "",
  "aws_secret_key": "",
  "created": "",
  "description": "",
  "id": "",
  "key_field": "",
  "last_modified": "",
  "list_content": "",
  "list_type": "",
  "name": "SubscriberStatus",
  "project_id": "",
  "s3_path": ""
}

400

// Invalid request body content
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

401

// Invalid credentials
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

default

// Unexpected error
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}