Publish a theme version

POST

/v2/themes/{themeId}/versions

curl --request POST \
  --url https://api.ligr.live/rest/v2/themes/1/versions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "graphics": [ { "graphicId": "example", "version": 1 } ], "activate": true }'

• LIGR REST API

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

Creates a theme version from the published graphic versions. Each graphic you do not list uses its latest published version, and the version leaves out a graphic that has no published version. Set activate to make the new version live.

Authorizations

• bearer
  themes:write
• api_key
  themes:write

Parameters

Path Parameters

themeId

required

Entity identifier

integer format: int32

>= 1

The theme identifier

Request Body^required

Media typeapplication/json

object

graphics

Pin these graphics to the given version. Unlisted graphics use their latest published version.

Array<object>

object

graphicId

required

string

version

required

integer format: int32

>= 1

activate

Set the new theme version active. Defaults to false.

boolean

Example^generated

{
  "graphics": [
    {
      "graphicId": "example",
      "version": 1
    }
  ],
  "activate": true
}

Responses

201

Created

Media typeapplication/json

object

version

required

The theme version this request created.

integer format: int32

activeVersion

required

Theme version the overlays render. Null means no version is active.

integer format: int32

nullable

Example^generated

{
  "version": 1,
  "activeVersion": 1
}

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 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"
}