Update List

Update a list.

PUT/v1/user/list/{id}

Param

Properties

Name	Type	Required	Description
id	number	✅	ID of the list

Example

/v1/user/list/123

Body

Properties

Name	Type	Required	Description
description	string	❌	Description of the list
title	string	❌	Title of the list
visibility	number	❌	Visibility of the list
item_ids	Object[]	❌	Item IDs associated with the list
item_ids.prompt_id	string	❌	Prompt ID of the item
item_ids.list_id	number	❌	List ID of the item
is_premium	boolean	❌	Indicates if the list is premium
is_fixed_price	boolean	❌	Indicates if the list has a fixed price
price	number	❌	Price of the list
price_original	number	❌	Original price of the list
avatar	Object	❌	Avatar of the list
avatar.file_name	string	❌	Name of the avatar
avatar.file_buffer	number[]	✅	Buffer of the avatar
cover_images	Object[]	❌	Cover images of the list. Up to 3 images
cover_images.file_name	string	❌	Name of the cover image
cover_images.file_buffer	number[]	✅	Buffer of the cover image
images	Object[]	❌	Images of the list. Up to 3 images
images.file_name	string	❌	Name of the image
images.file_buffer	number[]	✅	Buffer of the image
tagIds	number[]	❌	Tag IDs of the list
video_url	string	❌	Video URL of the list
tutorial_steps	Object[]	❌	Tutorial steps of the list
tutorial_steps.title	string	✅	Title of the tutorial step
tutorial_steps.description	string	❌	Description of the tutorial step
tutorial_steps.video_url	string	❌	Video URL of the tutorial step
table	Object[]	❌	List content in the table
table.{crossed_list_id}	Object	❌	Cell in the table
table.{crossed_list_id}.content	Object[]	❌	Content of the cell

Example

{
  "title": "My First List",
  "description": "I will add all my favorite prompts here"
}

Response

Properties

Name	Type	Description
id	number	Unique identifier of the list
is_list	boolean	Indicates if the list is a list
title	string	Title of the list
description	string	Description of the list
description_plaintext	string	Description of the list in plain text
visibility	Object	Visibility of the list
visibility.id	number	ID of the visibility
visibility.name	string	Name of the visibility
items	Object[]	Items of the list
items.id	string	ID of the item
items.is_list	boolean	Indicates if the item is a list
items.type	Object	Type of the item
items.type.id	number	ID of the type
items.type.name	string	Name of the type
items.category	Object	Category of the item
items.category.id	number	ID of the category
items.category.name	string	Name of the category
items.topics	null	Topics related to the item
items.title	string	Title of the item
items.body_content	string	Body content of the item
items.body_content_plaintext	string	Body content of the item in plain text
items.body_content_json	null	Body content of the item in JSON format
items.body_content_placeholders	Object	Placeholders for the body content
items.body_content_placeholders.list	null	Placeholders for the body content in list
items.body_content_placeholders.plaintext	string	Placeholders for the body content in plain text
items.description	string	Description of the item
items.description_plaintext	string	Description of the item in plain text
items.visibility	Object	Visibility of the item
item.visibility.id	number	ID of the visibility
item.visibility.name	string	Name of the visibility
item.images	null	Images related to the item
item.cover_images	null	Cover images related to the item
item.avatar_image	string	Avatar image of the item
item.tags	null	Tags related to the item
item.tutorial_steps	null	Tutorial steps related to the item
item.url	string	URL of the item
item.is_premium	boolean	Indicates if the item is premium
item.price	number	Price of the item
item.average_rate	number	Average rate of the item
item.video_url	string	URL of the video
item.created_at	string	Creation date of the item
item.updated_at	null	Update date of the item
item.user	User	User of the item
item.total_upvotes	number	Total upvotes of the item
item.total_uses	number	Total uses of the item
item.total_saves	number	Total saves of the item
item.command	string	Command of the item
item.knowledge_base	string	Knowledge base of the item
total_items	number	Total items of the list
type	Object	Type of the list
type.id	number	ID of the type
type.name	string	Name of the type
topics	null	Topics related to the list
cover_images	null	Cover images of the list
avatar_image	null	Avatar image of the list
video_url	null	URL of the video
tags	null	Tags of the list
tutorial_steps	null	Tutorial steps of the list
url	string	URL of the list
is_premium	boolean	Indicates if the list is premium
price	number	Price of the list
created_at	string	Creation date of the list
updated_at	null	Update date of the list
is_saved	boolean	Indicates if the list is saved
is_favorite	boolean	Indicates if the list is favorite
average_rate	number	Average rate of the list
rates	null	Rates of the list
total_rates	number	Total rates of the list
is_voted	boolean	Indicates if the list is voted
total_saves	number	Total saves of the list
total_upvotes	number	Total upvotes of the list
total_uses	number	Total uses of the list
total_sales	number	Total sales of the list
user	User	User of the list
last_saves	null	Last saves of the list
knowledge_base	string	Knowledge base of the list
table_id	string	ID of the table that list belongs to

Example

{
  "response": {
    "id": 15130,
    "is_list": true,
    "title": "Row 1",
    "description": "",
    "description_plaintext": "",
    "visibility": {
      "id": 2,
      "name": "Unlisted"
    },
    "items": [
      {
        "id": "d985c987-8445-48f1-9e54-b4844e081c18",
        "is_list": false,
        "type": {
          "id": 8,
          "name": "Cell"
        },
        "category": {
          "id": 18,
          "name": "Text"
        },
        "topics": null,
        "title": "Best Company",
        "body_content": "<p>Snack Prompt</p>",
        "body_content_plaintext": "Snack Prompt",
        "body_content_json": null,
        "body_content_placeholders": {
          "list": null,
          "plaintext": ""
        },
        "description": "",
        "description_plaintext": "",
        "visibility": {
          "id": 2,
          "name": "Unlisted"
        },
        "images": null,
        "cover_images": null,
        "avatar_image": "",
        "tutorial_steps": null,
        "tags": null,
        "url": "https://snackprompt.com/cell/best-company",
        "is_premium": false,
        "price": 0,
        "average_rate": 0,
        "video_url": "",
        "created_at": "2025-01-15T22:03:07.220613Z",
        "updated_at": null,
        "user": {
          "id": "Ak2o2WP6xrU8EqSLpmtwO4fEwlC3",
          "name": "Leonardo Sola",
          "username": "sola",
          "avatar": "http://..."
        },
        "total_upvotes": 0,
        "total_uses": 0,
        "total_saves": 0,
        "command": "",
        "knowledge_base": "Title: Best Company\nDescription: \n\nBody: Snack Prompt\n\n"
      },
      {
        "id": "52a8907e-fc22-4cf0-911e-ce30c08cfabd",
        "is_list": false,
        "type": {
          "id": 8,
          "name": "Cell"
        },
        "category": {
          "id": 18,
          "name": "Text"
        },
        "topics": null,
        "title": "Truth",
        "body_content": "<p>YES!</p>",
        "body_content_plaintext": "YES!",
        "body_content_json": null,
        "body_content_placeholders": {
          "list": null,
          "plaintext": ""
        },
        "description": "",
        "description_plaintext": "",
        "visibility": {
          "id": 2,
          "name": "Unlisted"
        },
        "images": null,
        "cover_images": null,
        "avatar_image": "",
        "tutorial_steps": null,
        "tags": null,
        "url": "https://snackprompt.com/cell/truth",
        "is_premium": false,
        "price": 0,
        "average_rate": 0,
        "video_url": "",
        "created_at": "2025-01-15T22:03:07.220613Z",
        "updated_at": null,
        "user": {
          "id": "Ak2o2WP6xrU8EqSLpmtwO4fEwlC3",
          "name": "Leonardo Sola",
          "username": "sola",
          "avatar": "http://..."
        },
        "total_upvotes": 0,
        "total_uses": 0,
        "total_saves": 0,
        "command": "",
        "knowledge_base": "Title: Truth\nDescription: \n\nBody: YES!\n\n"
      },
      {
        "id": "3a146c1a-e1b7-4036-a7ea-f06ee92e0160",
        "is_list": false,
        "type": {
          "id": 8,
          "name": "Cell"
        },
        "category": {
          "id": 18,
          "name": "Text"
        },
        "topics": null,
        "title": "Infinity",
        "body_content": "<p>Too much</p>",
        "body_content_plaintext": "Too much",
        "body_content_json": null,
        "body_content_placeholders": {
          "list": null,
          "plaintext": ""
        },
        "description": "",
        "description_plaintext": "",
        "visibility": {
          "id": 2,
          "name": "Unlisted"
        },
        "images": null,
        "cover_images": null,
        "avatar_image": "",
        "tutorial_steps": null,
        "tags": null,
        "url": "https://snackprompt.com/cell/infinity",
        "is_premium": false,
        "price": 0,
        "average_rate": 0,
        "video_url": "",
        "created_at": "2025-01-15T22:03:07.220613Z",
        "updated_at": null,
        "user": {
          "id": "Ak2o2WP6xrU8EqSLpmtwO4fEwlC3",
          "name": "Leonardo Sola",
          "username": "sola",
          "avatar": "http://..."
        },
        "total_upvotes": 0,
        "total_uses": 0,
        "total_saves": 0,
        "command": "",
        "knowledge_base": "Title: Infinity\nDescription: \n\nBody: Too much\n\n"
      }
    ],
    "total_items": 3,
    "type": {
      "id": 8,
      "name": ""
    },
    "topics": null,
    "cover_images": null,
    "avatar_image": null,
    "video_url": null,
    "tutorial_steps": null,
    "tags": null,
    "url": "https://snackprompt.com/list/67863439-c72e-4fe0-a27c-2822bf47156frow177id",
    "is_premium": false,
    "price": 0,
    "created_at": "2025-01-15T22:03:07.220613Z",
    "updated_at": null,
    "is_saved": false,
    "is_favorite": false,
    "average_rate": 0,
    "rates": null,
    "total_rates": 0,
    "is_voted": false,
    "total_saves": 0,
    "total_upvotes": 0,
    "total_uses": 0,
    "total_sales": 0,
    "user": {
      "id": "Ak2o2WP6xrU8EqSLpmtwO4fEwlC3",
      "name": "Leonardo Sola",
      "username": "sola",
      "avatar": "http://..."
    },
    "last_saves": null,
    "knowledge_base": "Title: Row 1\nDescription: \n\n - Item 1 - Title: Best Company\n - Item 1 - Description: \n - Item 1 - Body: Snack Prompt\n\n - Item 2 - Title: Truth\n - Item 2 - Description: \n - Item 2 - Body: YES!\n\n - Item 3 - Title: Infinity\n - Item 3 - Description: \n - Item 3 - Body: Too much\n\n",
    "table_id": "67863439-c72e-4fe0-a27c-2822bf47156f"
  }
}

CURL Example

curl -X PUT "https://api-integrations.snackprompt.com/v1/user/list/{id}" \
 -H "Content-Type: application/json" \
 -H "x-api-key: YOUR_API_KEY" \
 -d '{"title":"My First List","description":"I will add all my favorite prompts here"}'

Your API Key

note

The response header will return "list_URL" which is the URL of the updated list.