Your own effects

Delete an effect

DEL/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.

Deletes it and every reference to it: the shown effect, the layer, ambient, zones, scenes, likes and song shows.

Path parameters

idstringrequired

Your effect's id (u-…).

Responses

200OKapplication/json

oktruerequired

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 DELETE 'http://localhost:8080/api/custom-effects/id'

const res = await fetch("http://localhost:8080/api/custom-effects/id", {
  method: "DELETE",
});
const data = await res.json();
console.log(data);

import requests

res = requests.delete(
    "http://localhost:8080/api/custom-effects/id",
)
print(res.json())

Response

{
  "ok": true
}

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

{
  "error": "No such effect"
}