Properties

Create properties in bulk

post/v1/data/{workspace_id}/collections/{collection_id}/properties/batch

Authorizations

Authorizationstringheaderrequired

Use an account access token as Bearer <token>.

Send a JSON array of Property objects to add several fields to one collection. Use an array directly, not an object containing a properties or data field.

Each new property needs @type: "Property", name, range, and key. range describes its data type. key is the field name used in item data; use letters and digits, for example firstName. The property ID (@id) and its item-data key are distinct.

You can supply an @id for each property; otherwise the API generates one. Existing IDs cannot be overwritten by this endpoint. Optional property fields, such as description, unique, withIndex, and rank, work as they do for single-property creation.

On success, the API returns 201 Created with a data array of created IDs in the same order as the submitted properties. It does not return the full property definitions or one Location header per property. The sample response shows only the created IDs.

Use firstName and lastName, not the returned property IDs, when creating items. To retrieve the definitions after creation, list the collection's properties.

Request

import requests

url = "https://api.datablist.com/v1/data/workspace_example/collections/collection_example/properties/batch"

headers = {
    "Accept": "application/json",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

payload = [{
    "@type": "Property",
    "name": "First Name",
    "range": "Text",
    "key": "firstName"
}, {
    "@type": "Property",
    "name": "Last Name",
    "range": "Text",
    "key": "lastName"
}]

response = requests.post(url, headers=headers, json=payload)

print(response.text)

Response · illustrative example

{
  "data": [
    {
      "@id": "property_first_name"
    },
    {
      "@id": "property_last_name"
    }
  ]
}