Create a section

POST

/v2/control-rooms/{roomId}/sections

curl --request POST \
  --url https://api.ligr.live/rest/v2/control-rooms/1/sections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example" }'

• LIGR REST API

Beta. This operation can change between minor versions. See Beta status.

Appends a section to an organization-owned room and returns its generated identifier. The room’s owned theme must have an active published version.

Authorizations

• bearer
  themes:write
• api_key
  themes:write

Parameters

Path Parameters

roomId

required

Entity identifier

integer format: int32

>= 1

Request Body^required

Media typeapplication/json

object

name

required

string

>= 1 characters <= 80 characters

Example^generated

{
  "name": "example"
}

Responses

201

Created

Media typeapplication/json

object

id

required

string

name

required

string

colorKey

string

Example^generated

{
  "id": "example",
  "name": "example",
  "colorKey": "example"
}

400

Request is invalid

Media typeapplication/json

object

message

required

string

details

required

object

key

additional properties

Example^generated

{
  "message": "example",
  "details": {
    "additionalProperty": "example"
  }
}

401

Missing or invalid api key

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

403

Api key provides insufficient access for the request

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

404

Theme, control room, section, or graphic not found

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

429

Api key has made too many requests

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

500

An unexpected error has occured. If problems persist please contact support

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}