Skip to main content
POST
/
v1
/
properties
Create Property
curl --request POST \
  --url https://api.jtl-cloud.com/erp/v1/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": [
    123
  ]
}
'
{
  "Id": 123,
  "Name": "<string>",
  "Translations": [
    {
      "LanguageIso": "<string>",
      "Name": "<string>"
    }
  ],
  "PropertyGroups": [
    123
  ]
}

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
required

Name of the property in the standard language.

Translations
object[]

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

PropertyGroups
integer<int32>[]

IDs of property groups.

Response

The created property.

Model Class: Property

Id
integer<int32>
required

Unique ID to identify a property.

Name
string
required

Name of the property in the standard language.

Translations
object[]
required

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

PropertyGroups
integer<int32>[]
required

IDs of property groups.