Update a theme variable

PATCH

/v2/themes/{themeId}/variables/{id}

curl --request PATCH \
  --url https://api.ligr.live/rest/v2/themes/1/variables/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "ifUnchangedSince": "example", "type": "string", "defaultValue": "example", "description": "example", "enumOptions": [ "example" ], "isStyle": true }'

• LIGR REST API

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

Updates one theme variable. The request changes only the keys it names. The name never changes; delete the variable and create it again to rename it.

Authorizations

• bearer
  themes:write
• api_key
  themes:write

Parameters

Path Parameters

themeId

required

number format: double

The theme identifier

id

required

string

The variable identifier

Request Body^required

Media typeapplication/json

Body of PATCH /v2/themes/{themeId}/variables/{id}. The name never changes; delete and create a variable to rename it.

object

ifUnchangedSince

string

type

string

Allowed values: string number boolean enum

defaultValue

string

nullable

description

string

nullable

enumOptions

Array<string>

nullable

isStyle

boolean

Responses

200

Ok

Media typeapplication/json

Response of POST and PATCH on a theme variable.

updatedAt is the theme’s new updatedAt after this write. Send it back as ifUnchangedSince on the next write, in place of a fresh list read.

object

id

required

Equal to name for a variable this API created.

string

name

required

string

type

required

string

Allowed values: string number boolean enum

defaultValue

required

The value in force when a competition sets nothing. Null means no default.

string

nullable

description

required

string

nullable

enumOptions

required

Allowed values of an enum variable. Null for the other types.

Array<string>

nullable

isStyle

required

True when the variable holds a colour, a font or another style value.

boolean

updatedAt

required

string

Example

{
  "type": "string"
}

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 or variable not found

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

409

IfUnchangedSince no longer matches the theme

Media typeapplication/json

Body of a 409 answer when the caller’s ifUnchangedSince no longer matches.

code is always TARGET_CHANGED. Read the resource again and send the write once more.

object

message

required

string

code

required

string

Example^generated

{
  "message": "example",
  "code": "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"
}