Create a property

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

Authorizations

Authorizationstringheaderrequired

Use an account access token as Bearer <token>.

Get an access token ↗

Create a property with the fields shown below. See the Property object for all fields.

To add several fields in one request, use bulk property creation.

The key is used to define your items data structure. The range defines the property data type, such as Text.

For example, a collection with a property having a firstName key will have items with this structure:

json

{
  "@id": "item_example",
  "firstName": "John"
}

A successful request returns 201 Created with {"@id": "PROPERTY_ID"} and the new object's URL in the Location header.

Request

PythoncURLJavaScriptPHPGo

import requests

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

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

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

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

print(response.text)

Response · illustrative example

201

{
  "@id": "property_example"
}