POST /list_attributes
Create a List Attribue with provided name, list_type and key_field. Fields description and list_content are optional.
Servers
- https://api.optimizely.com/v2
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
key_field |
String | Yes |
The name of the object which holds targeting ids on your website |
project_id |
Integer | Yes |
The ID of the project the List Attribute belongs to |
archived |
Boolean | No |
Whether or not the List Attribute has been archived Default value: false |
description |
String | No |
A short description of the List Attribute |
last_modified |
String | No |
The last time the List Attribute was modified |
aws_access_key |
String | No |
AWS access key to upload List Attribute source file to S3 |
list_content |
String | No |
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. |
id |
Integer | No |
The unique identifier for the List Attribute |
created |
String | No |
Time when the List Attribute was created |
name |
String | Yes |
A unique, human-readable name for the List Attribute |
aws_secret_key |
String | No |
AWS secret key to upload List Attribute source file to S3 |
list_type |
String | No |
The type of data object which holds targeting ids on your website (cookies, query parameters, zip codes, Global JS variables) Valid values:
|
s3_path |
String | No |
S3 path containing files used to populate the List Attribute with data. Can be used with an S3 client or CLI to upload data. |
account_id |
Integer | No |
The unique identifier for the Optimizely account |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.