Sign in

v4

latestOpenAPI 3.0.02026-08-04109113304.5 KB
List Attributes

Update a List Attribute

Overwrite the List Attribute with the provided id. Required arguments are identical to creating a new List Attribute.

patch/list_attributes/{list_attribute_id}

Path parameters

list_attribute_idinteger required

The ID of the List Attribute you'd like to update

Request body

archivedboolean

Whether or not the List Attribute has been archived

descriptionstring

A short description of the List Attribute

key_fieldstring

The name of the object which holds targeting ids on your website

list_contentstring

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_type'cookies' | 'query_parameters' | 'zip_codes' | 'js_variables'

The type of data object which holds targeting ids on your website (cookies, query parameters, zip codes, Global JS variables)

namestring

A unique, human-readable name for the List Attribute

Example request

{
  "name": "SubscriberStatus"
}

Response

Successfully updated the List Attribute

account_idinteger

The unique identifier for the Optimizely account

archivedboolean

Whether or not the List Attribute has been archived

aws_access_keystring

AWS access key to upload List Attribute source file to S3

aws_secret_keystring

AWS secret key to upload List Attribute source file to S3

createdstring date-time

Time when the List Attribute was created

descriptionstring

A short description of the List Attribute

idinteger

The unique identifier for the List Attribute

key_fieldstring required

The name of the object which holds targeting ids on your website

last_modifiedstring date-time

The last time the List Attribute was modified

list_contentstring

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_type'cookies' | 'query_parameters' | 'zip_codes' | 'js_variables'

The type of data object which holds targeting ids on your website (cookies, query parameters, zip codes, Global JS variables)

namestring required

A unique, human-readable name for the List Attribute

project_idinteger required

The ID of the project the List Attribute belongs to

s3_pathstring

S3 path containing files used to populate the List Attribute with data. Can be used with an S3 client or CLI to upload data.

Example response

{
  "name": "SubscriberStatus"
}