Mark a List Public

Make a "list" public to make it shareable to everyone.


Authenticated users only. Implementations that need to support this need to build out logic only for logged-in users where the source email is clear.


Endpointrequest typeAPI Type
{{Swym API Endpoint }}/api/v3/lists/markPublicPOSTshopper

Query Params

pidstring (Encoded)YesUnique identifier for the store available in Swym Admin
limitint64NoMaximum number of records to return
offsetint64NoNumber of records to skip

Form Data

regidstringYesUnique identifier for the shopper generated by generate-regid
sessionidstringYesSession id generated with generate-regId endpoint which does not expire without manual intervention
lidstringYesUnique identifier of the list.

Example Curl

An example of a /api/v3/lists/markPublic request with lid

curl --location --request POST '{{Swym API Endpoint}}/api/v3/lists/markPublic?pid={{URL Encoded PID}}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Accept: application/json' \
--data-urlencode 'regid={{regid}}' \
--data-urlencode 'sessionid={{sessionid}}' \
--data-urlencode 'lid={{lid}}'

var axios = require('axios');
var qs = require('qs');
var data = qs.stringify({
  'regid': '{{regid}}',
  'sessionid': '{{sessionid}}',
  'lid': '{{lid}}' 
var config = {
  method: 'post',
  url: '{{Swym API Endpoint}}/api/v3/lists/markPublic?pid={{URL Encoded  PID}}',
  headers: { 
    'Content-Type': 'application/x-www-form-urlencoded', 
    'Accept': 'application/json'
  data : data

.then(function (response) {
.catch(function (error) {


Curl Placeholders

Assuming these values are provided above, the curl command should work correctly. However, if there are any issues with the API endpoint or the data being passed in the request, there could still be errors that need to be resolved before you can test these APIS.

{{Swym API Endpoint}}This needs to be replaced with the actual Swym API endpoint URL.
{{URL Encoded PID}}This needs to be replaced with the actual PID value, URL-encoded.
{{regid}}This needs to be replaced with the actual regid value.
{{sessionid}}This needs to be replaced with the actual session ID value.
{{lid}}This needs to be replaced with the actual list ID value.

Success Response

When the list is marked public, the entire list contents are returned, this allows anyone with the lid to view the list.

         "dt":"Blue Silk Tuxedo",
         "dt":"Black Leather Bag",
         "cby":"[email protected]",
   "lnote":"I am newly updated.",
   "lname":"My Wishlist",

Error Response:

    "error": true,
    "msg": "List Not Found",
    "type": "sw-entity-notfound",
    "uid": "ny2AXQ5m7rQ7sRsaTmXvvafMGCKfwTbZY/5eZ3FTH+w=",
    "di": "c0deab58-8510-4aa2-9a1a-328812c8e0a1-API",
    "lid": "671de5eb-e69f-4b25-8ab7-0b9cd245f27"

Error Status Codes

If the request is unsuccessful, the API will return a JSON response with an error message and an HTTP status code indicating the type of error that occurred.

Status CodeTypeDescription
400Bad RequestYour request is invalid, change your request params and query and try again.
401UnauthorisedYou are performing an action on a resource that is not granted to the current logged-in user. Additionally, for REST APIs, this could mean your API key is wrong.
403ForbiddenYou are not allowed to request this data.
404Not FoundThe specified requested data could not be found.
429Too Many RequestsYou're raising too many requests! Slow down!
500Internal Server Error --We had a problem with our server. Try again later.
503Service UnavailableWe're temporarily offline for maintenance. Please try again later.