Remove Item from List

Remove an elemental or list from a list.

DELETE/v1/user/list/{id}/elementals

Param

Properties

Name	Type	Required	Description
id	number	✅	ID of the list

Example

/v1/user/list/123/elementals

Body

Properties

Name	Type	Required	Description
item_ids	Object[]	✅	List of item IDs to remove
prompt_id	string	❌	ID of the prompt
list_item_id	number	❌	ID of the list item
mode	string	❌	Mode of the request, 'delete' or 'remove'. If mode delete it will delete your own items within the list and remove the other users items.

Example

{
  "item_ids": [
    {
      "prompt_id": "your-prompt-id"
    },
    {
      "list_item_id": 1234
    }
  ],
  "mode": "remove"
}

CURL Example

curl -X DELETE "https://api-integrations.snackprompt.com/v1/user/list/{id}/elementals" \
 -H "Content-Type: application/json" \
 -H "x-api-key: YOUR_API_KEY" \
 -d '{"item_ids":[{"prompt_id":"your-prompt-id"},{"list_item_id":1234}],"mode":"remove"}'

Your API Key

warning

If mode is set to 'delete' it will delete your own items within the list and remove the other users items.

This action is irreversible.

info

This route will return a 200 status code if the list is successfully deleted.