Delete List File

Deletes files, images, cover images, or avatar image associated with a specific list

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

Param

Properties

Name	Type	Required	Description
id	number	✅	ID of the list

Example

/v1/user/list/123/files

Body

Properties

Name	Type	Required	Description
avatar	boolean	❌	Delete the avatar image
cover_images	number[]	❌	ID of the cover images to delete
images	number[]	❌	ID of the images to delete

Example

{
  "avatar": true,
  "cover_images": [
    123
  ]
}

CURL Example

curl -X DELETE "https://api-integrations.snackprompt.com/v1/user/list/{id}/files" \
 -H "Content-Type: application/json" \
 -H "x-api-key: YOUR_API_KEY" \
 -d '{"avatar":true,"cover_images":[123]}'

Your API Key

warning

This action is irreversible.

info

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