Your own effects

Change an effect

PUT/api/custom-effects/{id}

Guest area “effects”. Open unless a PIN lock is set and guests aren't allowed this area (settings.guest.effects); then it needs an unlock token.

Replaces your effect with this one (the same body as making it).

Path parameters

idstringrequired

Your effect's id (u-…).

Request body application/json

namestring

Up to 40 characters

patternstringrequired

One of "wave" "chase" "pulse" "sparkle" "fill" "breathe" "gradient"

axisstring

One of "along" "x" "y" "around" "centre"

Default "along"

drivestring

What moves it.

One of "beat" "kick" "bass" "loud" "time"

Default "beat"

tagstring

One of "calm" "build" "drop" "home"

Default "drop"

colors"palette" | string[]

palette, or two colours.

speednumber

Default 10.1 to 8

widthnumber

Default 0.150.01 to 1

cyclesnumber

Default 10.25 to 8

bgnumber

Background glow.

Default 0.050 to 0.5

Responses

200OKapplication/json

idstringrequired

u-…

namestring

Up to 40 characters

patternstringrequired

One of "wave" "chase" "pulse" "sparkle" "fill" "breathe" "gradient"

axisstring

One of "along" "x" "y" "around" "centre"

Default "along"

drivestring

What moves it.

One of "beat" "kick" "bass" "loud" "time"

Default "beat"

tagstring

One of "calm" "build" "drop" "home"

Default "drop"

colors"palette" | string[]

palette, or two colours.

speednumber

Default 10.1 to 8

widthnumber

Default 0.150.01 to 1

cyclesnumber

Default 10.25 to 8

bgnumber

Background glow.

Default 0.050 to 0.5

400The body isn't valid JSON, or a value is wrong.application/json

errorstringrequired

What went wrong, in a sentence for people.

403Locked, or not allowed.application/json

errorstringrequired

What went wrong, in a sentence for people.

404No such id.application/json

errorstringrequired

What went wrong, in a sentence for people.

Request

curl -X PUT 'http://localhost:8080/api/custom-effects/u-k3j9q2' \
  -H 'content-type: application/json' \
  -d '{
  "name": "Pink chase",
  "pattern": "chase",
  "axis": "along",
  "drive": "kick",
  "tag": "drop",
  "colors": [
    "#ff0066",
    "#00ccff"
  ],
  "speed": 2,
  "width": 0.1
}'

const res = await fetch("http://localhost:8080/api/custom-effects/u-k3j9q2", {
  method: "PUT",
  headers: { "content-type": "application/json" },
  body: JSON.stringify({
    "name": "Pink chase",
    "pattern": "chase",
    "axis": "along",
    "drive": "kick",
    "tag": "drop",
    "colors": [
      "#ff0066",
      "#00ccff"
    ],
    "speed": 2,
    "width": 0.1
  }),
});
const data = await res.json();
console.log(data);

import requests

res = requests.put(
    "http://localhost:8080/api/custom-effects/u-k3j9q2",
    json={
        "name": "Pink chase",
        "pattern": "chase",
        "axis": "along",
        "drive": "kick",
        "tag": "drop",
        "colors": [
            "#ff0066",
            "#00ccff"
        ],
        "speed": 2,
        "width": 0.1
    },
)
print(res.json())

Response

{
  "id": "u-k3j9q2",
  "name": "Pink chase",
  "tag": "drop",
  "pattern": "chase",
  "axis": "along",
  "drive": "kick",
  "colors": [
    "#ff0066",
    "#00ccff"
  ],
  "speed": 2,
  "width": 0.1,
  "bg": 0.05,
  "cycles": 1
}

{
  "error": "Colours are two like #ff0066"
}

{
  "error": "Settings are locked. Unlock with the PIN in Settings."
}

{
  "error": "No such effect"
}