Delete List

Public Beta Feature

This documentation covers a feature currently in Public Beta. Access is available to anyone interested in building personalized experiences for their end-users.

This feature is subject to the Personalization API (Self-Service) Public Beta End user License Agreement.

Parameters

• list_id
  Type: string
  Required: Yes
  The ID of the list to be acted upon.

• v
  Type: string
  Required: Yes
  The API version date as documented here; e.g. 20231010

Response Codes

• 200
  Response object for successful deletion of a list.

• meta
  Metadata object for successful deletion of a list.

  • code
    Type: integer
    Defaults to 0
    Status code indicating the result of the API request for deleting a list with the given id.
  • requestId
    Type: string
    The unique identifier for the API request.
  • notifications
    Type: array of objects
    Array of notification objects containing information about the success of the deletion of a list.
    • notifications
      Type: object
      Array of notification objects for the successful deletion of a list item.
      • item
        Type: object
        List of notifications for the item that was successfully deleted from the specified list.
        • type
          Type: string
          The type of notification.

• 400
  Indicates a bad request error.

Example cURL Request

curl --request POST \
     --url https://api.foursquare.com/v2/lists/list_id/delete \
     --header 'accept: application/json'

Example Response

{
  "meta": {
    "code": 200,
    "requestId": "6418cb0b6d5b3b4c67af1bde"
  },
  "notifications": [
    {
      "type": "notificationTray",
      "item": {
        "unreadCount": 0
      }
    }
  ],
  "response": {}
}