Skip to main content
POST
/
v2
/
properties
Create Property
curl --request POST \
  --url https://api.jtl-cloud.com/erp/v2/properties \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "name": "<string>",
  "translations": [
    {
      "languageIso": "<string>",
      "name": "<string>"
    }
  ],
  "propertyGroups": [
    "b45f6432-2462-4c6f-b00f-1d9d01000000"
  ]
}
'
{
  "id": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "name": "<string>",
  "translations": [
    {
      "languageIso": "<string>",
      "name": "<string>"
    }
  ],
  "propertyGroups": [
    "b45f6432-2462-4c6f-b00f-1d9d01000000"
  ]
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

​
x-runas
string

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

​
x-companyid
string

The Company-Id (int or uuid) of the company on whose behalf the request is executed.

Body

application/json

The property to create.

Model Class: CreateProperty

​
name
string

Name of the property in the standard language.

​
translations
object[]

Different terms for the property in the non-default languages.

​
propertyGroups
string<uuid>[]

IDs of property groups.

Response

The created property.

Model Class: Property

​
id
string<uuid>

Unique ID to identify a property.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

​
name
string

Name of the property in the standard language.

​
translations
object[]

Different terms for the property in the non-default languages.

​
propertyGroups
string<uuid>[]

IDs of property groups.