The availability of features may depend on your plan type. Contact your Customer Success Manager if you have any questions.
Dev guideRecipesAPI ReferenceChangelog
Dev guideAPI ReferenceRecipesChangelogUser GuideGitHubDev CommunityOptimizely AcademySubmit a ticketLog In
API Reference

Create a List Attribute

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

A string in JSON format that includes all the fields to create a new List Attribute

boolean
Defaults to false

Whether or not the List Attribute has been archived

string

A short description of the List Attribute

string
required

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

string

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.

string
enum

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

Allowed:
string
required

A unique, human-readable name for the List Attribute

int64
required

The ID of the project the List Attribute belongs to

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json