Update 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
  string
  required
  The ID of the list to be acted upon.

• v
  string
  required
  The API version date as documented here; e.g. 20231010

• name
  string

• description
  string

• photoId
  string

Response Object:

• 200
  object
  Response object containing updated data for a specific list upon a successful update request.

• meta
  object
  The metadata object for the success response when updating a list item.

• code
  integer
  Defaults to 0
  The status code indicating the result of the update request for the specified list.

• requestId
  string
  Unique identifier for the API request associated with the 200 (OK) response from updating a list with a specific ID.

• notifications
  array of objects
  Array of notification objects containing updates for the specified list.

• item
  object
  Array of notification objects for the updated list with a status code of 200.

Item Object:

• type
  string
  The type of notification for items in the specified list.

• response
  object
  The response object containing the updated data for a specific list.

• list
  object
  Properties of the updated list response for a successful API request.

List Object:

• 200
  Updated 5 months ago

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

{
  "meta": {
    "code": 200,
    "requestId": "641a2bbefdd741133a5fb88a"
  },
  "notifications": [
    {
      "type": "notificationTray",
      "item": {
        "unreadCount": 0
      }
    }
  ],
  "response": {
    "list": {
      "id": "641a25e7cf08c07fbebbccc3",
      "name": "Not Worth It",
      "description": "Find other places to blow your diet!",
      "type": "created",
      "user": {
        "id": "123456",
        "firstName": "John",
        "lastName": "Smith",
        "gender": "male",
        "countryCode": "US",
        "relationship": "self",
        "canonicalUrl": "https://foursquare.com/user/123456",
        "canonicalPath": "/user/123456",
        "photo": {
          "prefix": "https://fastly.4sqi.net/img/user/",
          "suffix": "/blank_boy.png",
          "default": true
        },
        "isAnonymous": false
      },
      "editable": true,
      "public": true,
      "collaborative": false,
      "url": "/user/123456/list/not-worth-it",
      "canonicalUrl": "https://foursquare.com/user/123456/list/not-worth-it",
      "canonicalPath": "/user/123456/list/not-worth-it",
      "createdAt": 1679435239,
      "updatedAt": 1679435239,
      "visitedCount": 0,
      "venueCount": 0,
      "categories": {
        "count": 0,
        "items": []
      },
      "following": false,
      "followers": {
        "count": 0
      },
      "collaborators": {
        "count": 0,
        "items": []
      },
      "sort": "list-order",
      "listItems": {
        "count": 0,
        "items": []
      },
      "completedCount": 0
    }
  }
}