AIairship
Static Lists

Create list

Changed on

Create a static list. The body of the request will contain several of the list object parameters, but the actual list content will be provided by a second call to the upload endpoint. You can upload up to 100 lists per project.

post/api/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.

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

  • 3304568aaadcRevision changes
    • breaking

      the request property's minLength was increased from 0 to 1

    • breaking

      added the pattern ^[a-zA-Z0-9_-]*$ to the request property

    This list may be incomplete.