For the complete documentation index, see llms.txt. This page is also available as Markdown.

Rename a watchlist

Renames a watchlist owned by the authenticated customer.

patch
Authorizations
AuthorizationstringRequired

Your storefront (public) token, sent as Authorization: Bearer STOREFRONT_TOKEN. Generate one in Auction Plus under Settings > API, in the Storefront API section, by clicking Generate Public Token. Required on every request.

Path parameters
idstringRequired

The watchlist UID.

Example: 1c6af60by54hzdmgxy5ab4ypw0
Query parameters
fields[watchlists]stringOptional

Available values are name, createdAt, updatedAt. You can include multiple values by separating them with a comma.

Body
namestring · max: 255Required

The watchlist name. Must be unique among the customer's watchlists.

Responses
200

WatchlistResource

application/vnd.api+json
patch/watchlists/{id}
PATCH /storefront/v1/watchlists/{id} HTTP/1.1
Host: api.auctionplusapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}
{
  "data": {
    "id": "text",
    "type": "text",
    "attributes": {
      "name": "text",
      "createdAt": null,
      "updatedAt": null
    }
  }
}

Last updated