Remove from a list

Remove one or more values from a list. Values that aren't in the list are skipped, so the call succeeds even when some of them were already gone. The change applies to the next evaluation.

Parameters

---

id string _^REQUIRED

The ID of the list, from its URL in the dashboard. The list must belong to the same environment as your project secret.

---

value string

A single value to remove. Pass either value or values.

---

values array of strings

Up to 500 values to remove in one call. Pass either value or values.

Returns

---

Returns how many values were removed and the list's total number of active values. Returns 404 when the list doesn't exist in the environment your project secret belongs to.

const result = await rupt.removeFromList({ list: "LIST_ID", values: "USER_ID" });

{
  "removed": 1,
  "total": 13
}