curl --request POST \
--url https://api.poelis.com/v1/public/properties/bulk \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"properties": [
{
"item_id": "<string>",
"type": "<string>",
"name": "<string>",
"readable_id": "<string>",
"value": "<unknown>",
"category": "<string>",
"display_unit": "<string>"
}
]
}
'import requests
url = "https://api.poelis.com/v1/public/properties/bulk"
payload = { "properties": [
{
"item_id": "<string>",
"type": "<string>",
"name": "<string>",
"readable_id": "<string>",
"value": "<unknown>",
"category": "<string>",
"display_unit": "<string>"
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
properties: [
{
item_id: '<string>',
type: '<string>',
name: '<string>',
readable_id: '<string>',
value: '<unknown>',
category: '<string>',
display_unit: '<string>'
}
]
})
};
fetch('https://api.poelis.com/v1/public/properties/bulk', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"count": 1,
"items": [
{
"category": "POWER",
"createdBy": {
"id": "auth0|550e8400-e29b-41d4-a716-446655440000",
"imageUrl": "https://example.com/avatar.png",
"userName": "Jane Doe"
},
"deleted": false,
"display_unit": "kW",
"id": "550e8400-e29b-41d4-a716-446655440000",
"item_id": "660e8400-e29b-41d4-a716-446655440001",
"name": "Maximum Power",
"readable_id": "max-power",
"references": [
{
"file_link_id": "890e8400-e29b-41d4-a716-446655440000",
"page": 42
}
],
"type": "numeric",
"value": 150.5
}
]
}{
"error": "unauthorized",
"message": "Invalid or missing API key"
}{
"error": "forbidden",
"message": "Access denied"
}{
"error": "not_found",
"message": "Not found"
}{
"error": "validation_error",
"message": "Invalid data format",
"details": {
"errors": [
{
"loc": [
"body",
"field_name"
],
"msg": "field required",
"type": "value_error.missing"
}
]
}
}{
"error": "rate_limit_exceeded",
"message": "Too many requests"
}Bulk create properties
Create multiple properties in a single all-or-nothing request.
Overview
Accepts 1–50 properties. If any row fails validation or persistence, the entire batch
is rolled back and no properties are created. Error responses include details.index
(0-based) identifying the failing row.
Each item_id must refer to an existing draft item. Formula properties cannot be created.
Validation
Same rules as single-property create: type, value, category, and display_unit constraints
apply to every row. Duplicate readable_id values within the same item (in the batch or
already stored) return 409.
curl --request POST \
--url https://api.poelis.com/v1/public/properties/bulk \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"properties": [
{
"item_id": "<string>",
"type": "<string>",
"name": "<string>",
"readable_id": "<string>",
"value": "<unknown>",
"category": "<string>",
"display_unit": "<string>"
}
]
}
'import requests
url = "https://api.poelis.com/v1/public/properties/bulk"
payload = { "properties": [
{
"item_id": "<string>",
"type": "<string>",
"name": "<string>",
"readable_id": "<string>",
"value": "<unknown>",
"category": "<string>",
"display_unit": "<string>"
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
properties: [
{
item_id: '<string>',
type: '<string>',
name: '<string>',
readable_id: '<string>',
value: '<unknown>',
category: '<string>',
display_unit: '<string>'
}
]
})
};
fetch('https://api.poelis.com/v1/public/properties/bulk', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"count": 1,
"items": [
{
"category": "POWER",
"createdBy": {
"id": "auth0|550e8400-e29b-41d4-a716-446655440000",
"imageUrl": "https://example.com/avatar.png",
"userName": "Jane Doe"
},
"deleted": false,
"display_unit": "kW",
"id": "550e8400-e29b-41d4-a716-446655440000",
"item_id": "660e8400-e29b-41d4-a716-446655440001",
"name": "Maximum Power",
"readable_id": "max-power",
"references": [
{
"file_link_id": "890e8400-e29b-41d4-a716-446655440000",
"page": 42
}
],
"type": "numeric",
"value": 150.5
}
]
}{
"error": "unauthorized",
"message": "Invalid or missing API key"
}{
"error": "forbidden",
"message": "Access denied"
}{
"error": "not_found",
"message": "Not found"
}{
"error": "validation_error",
"message": "Invalid data format",
"details": {
"errors": [
{
"loc": [
"body",
"field_name"
],
"msg": "field required",
"type": "value_error.missing"
}
]
}
}{
"error": "rate_limit_exceeded",
"message": "Too many requests"
}Authorizations
Enter your API key. Example: Bearer poelis_api_...
Body
Request to create multiple properties in one all-or-nothing transaction.
Properties to create (1–50). The request is all-or-nothing: if any row fails, none are created. Formula properties cannot be created. Each item_id must refer to an existing draft item.
1 - 50 elementsShow child attributes
Show child attributes