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

Authorizations

Authorization
string
header
required

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

x-api-key
string
header
required

Optional: If no token is present, the API Gateway injects it.

Headers

x-appid
string
required

This is the name of your application, e.g. "MyApp/1.0.0". It is used to identify your application.

x-appversion
string
required

This is where the version number of your application is entered, e.g. "1.0.0".

x-runas
string

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

X-SessionId
string<uuid>

The id of a session in which the call will be executed.

x-companyid
string

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

x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

Body

application/json

The property group to create.

Model Class: CreatePropertyGroup

name
string

Name of the property group.

Response

The created property group.

Model Class: PropertyGroup

id
string<uuid>

Unique ID to identify a property group.

Example:

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

name
string

Name of the property group.