Create 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.

API Parameters

version
string
Required. The API version date as documented here; e.g. 20231010

name
string
Provide a name for the list being created.

description
string
Provide a description of the created list.

Response Example

HTTP Status Codes

200

{
  "meta": {
    "code": 200,
    "requestId": "641a25e7d789ea1a17015592"
  },
  "notifications": [
    {
      "type": "notificationTray",
      "item": {
        "unreadCount": 0
      }
    }
  ],
  "response": {
    "list": {
      "id": "641a25e7cf08c07fbebbccc3",
      "name": "Stay Away From List",
      "description": "All the not so amazing things!",
      "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/stay-away-from-list",
      "canonicalUrl": "https://foursquare.com/user/123456/list/stay-away-from-list",
      "canonicalPath": "/user/123456/list/stay-away-from-list",
      "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
    }
  }
}

400