Skip to main content
POST
/
component-groups
Create Component Group
curl --request POST \
  --url http://localhost/api/component-groups \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "order": 1,
  "visible": true,
  "components": [
    1
  ]
}
'
{
  "data": {
    "id": "<string>",
    "type": "componentGroups",
    "attributes": {
      "id": 123,
      "name": "<string>",
      "order": 123,
      "visible": 0,
      "created": {
        "human": "<string>",
        "string": "<string>"
      },
      "updated": {
        "human": "<string>",
        "string": "<string>"
      }
    },
    "relationships": {
      "components": {
        "data": [
          {
            "type": "components",
            "id": "<string>"
          }
        ]
      }
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

CreateComponentGroupRequestData

​
name
string
required
Maximum string length: 255
​
order
integer | null
Required range: x >= 0
​
visible
boolean | null
​
components
integer[] | null
Required range: x >= 0

Response

ComponentGroup

​
data
ComponentGroup · object
required