Skip to content
Developers

Delete a control variable

DELETE/v2/themes/{themeId}/rive-graphics/{graphicId}/control-variables/{id}

DELETE
/v2/themes/{themeId}/rive-graphics/{graphicId}/control-variables/{id}
curl --request DELETE \
  --url https://api.ligr.live/rest/v2/themes/1/rive-graphics/example/control-variables/example \
  --header 'Authorization: Bearer <token>'

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

Removes a control variable. force blanks expressions that reference it.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
themeId
required
number format: double
graphicId
required
string
id
required
string

Query Parameters

Section titled “Query Parameters”
force
boolean
ifUnchangedSince
string

Responses

Section titled “Responses”

200

Section titled “200”

Ok

Media typeapplication/json
object
updatedAt
required
string
entityId
required

Id of the created or changed entity, or null for settings.

string
nullable
stateMachine
required
object
version
required
integer format: int32
currentArtboard
required
string
currentStateMachine
required
string
controlVariables
required
Array<object>
object
id
required
string
name
required
string
type
required
string
defaultValue
Any of:
boolean
value
Any of:
boolean
data
dataSchema
description
string
options
Array<string>
exitMode
string
Allowed values: immediate deferred
dataBindings
required
Array<object>
object
id
required
string
name
required
string
defaultValue
Any of:
boolean
value
string
expression
required
string
viewModelProperty
required
object
imageDimensions
object
height
required
number format: double
width
required
number format: double
viewModelId
required
string
viewModelName
required
string
listModel
string
sourceArrayPath
string
enumValues
Array<string>
type
required
string
path
required
string
exposed
object
name
required
string
expression
required
string
required
required
boolean
entityType
required
string
Allowed values: player team competition ad
width
number format: double
height
number format: double
imageTransform
object
outWidth
number format: double
outHeight
number format: double
fit
string
Allowed values: cover contain stretch
scaleX
number format: double
scaleY
number format: double
rotateDeg
number format: double
skewXDeg
number format: double
skewYDeg
number format: double
translateX
number format: double
translateY
number format: double
padding
object
top
number format: double
right
number format: double
bottom
number format: double
left
number format: double
background
object
r
number format: double
g
number format: double
b
number format: double
a
number format: double
anchor
string
Allowed values: center top-left top top-right left right bottom-left bottom bottom-right
stateMachineInputs
required
Array<object>
object
id
required
string
name
required
string
type
required
string
Allowed values: boolean number trigger
defaultValue
Any of:
boolean
value
required
Any of:
boolean
expression
string
userExpressions
Array<object>
object
id
required
string
name
required
string
expression
required
string
description
string
selectedSport
string
selectedSchemas
Array<string>
assets
required
Array<object>
object
id
required
string
name
required
string
uniqueFileName
required
string
type
required
string
Allowed values: image font audio
expression
string
unresolved
boolean
metadata
object
size
required
number format: double
width
number format: double
height
number format: double
fileId
number format: double
storageKey
string
sha256
string
exposed
required
object
name
required
string
defaultFileId
integer format: int32
>= 1
required
required
boolean
expression
string
entityType
required
string
Allowed values: player team competition ad
scale
required
number format: double
x
required
number format: double
y
required
number format: double
artboardWidth
required
number format: double
artboardHeight
required
number format: double
renderer
string
Allowed values: webgl2 canvas
deferInitialShow
boolean
Example
{
  "stateMachine": {
    "controlVariables": [
      {
        "exitMode": "immediate"
      }
    ],
    "dataBindings": [
      {
        "exposed": {
          "entityType": "player"
        },
        "imageTransform": {
          "fit": "cover",
          "anchor": "center"
        }
      }
    ],
    "stateMachineInputs": [
      {
        "type": "boolean"
      }
    ],
    "assets": [
      {
        "type": "image",
        "exposed": {
          "entityType": "player"
        }
      }
    ],
    "renderer": "webgl2"
  }
}