AIairship
Attribute Lists

Create attributes list

Create an attributes list with a name, description, and optional metadata. After creating the list, populate it with a CSV of Text, Number, or Date attribute data using the Upload attributes list endpoint.

post/api/attribute-lists

Request

Request body

descriptionstring

An optional description for the list.

extraunknown
namestring required

The name of the list, consists of up to 64 URL-safe characters. The name is how the list is identified, so it should be unique and memorable.

Note: Since the name portion of the URL may represent any Unicode string, it must be encoded properly as a URI path component. The encodeURIComponent function in JavaScript can be used.

The list name must include a prefix that determines how empty values are handled:

  • Lists with ua_attributes_ prefix: Empty or null values are ignored, preserving any existing attribute values not explicitly set in the CSV. This mode is useful for making partial updates to a user's attributes without affecting others.
  • Lists with ua_attributes_snapshot_ prefix: Empty or null values trigger removing those attributes from the user. This mode is useful for synchronizing attribute states with external systems, ensuring the attributes in the CSV exactly match the user's attributes.

Response

The list was created successfully.

okboolean required

Success.

operation_idstring uuid

A unique string identifying the operations that modify resources. Use the operation ID to locate and track grouped operations (i.e., a batch push operation may generate multiple push_id strings, but a single operation_id) or operations that change an existing resource.

Changes

No recorded changes to this operation across all 9 revisions of this API.