Sign in
Watchlist

Add product to watchlist

Changed on

Adds a product to the authenticated user's watchlist. The request body requires canonical productListingId and may set notifications; notifications default to true. Active-entry quota depends on the user's tier: Free users may have 20, Pro users 100, and Ultimate users have no active-entry limit. Adding beyond the active quota returns a 422 Unprocessable Entity error. Returns the created WatchlistEntryData. Requires a Cognito JWT or an Aura access token with watchlist:write.

post/api/v1/me/watchlist

Request

  • Base URL: https://api.stage.aura-historia.com
  • URL: https://api.stage.aura-historia.com/api/v1/me/watchlist
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Request body

productListingIdstring required

Canonical identifier of the product to add to the watchlist.

notificationsboolean

Whether notifications are enabled for this entry. Defaults to true.

Example request

{
  "productListingId": "pl_5xdb465tg1enarx2knf04mxbxj",
  "notifications": true
}

Response

Watchlist entry created successfully

userIdstring required

Identifier of the user who owns the entry.

productListingIdstring required

Canonical identifier of the watched product.

notificationsboolean required

Whether notifications are enabled for this entry.

state'ACTIVE' | 'INACTIVE_BY_USER' | 'INACTIVE_BY_RESTRICTED_PLAN' required

Activation state of a stored user-owned resource such as a saved search filter. ACTIVE resources are eligible for their normal runtime behavior. INACTIVE_BY_USER resources were explicitly deactivated by the user. INACTIVE_BY_RESTRICTED_PLAN resources remain stored but are inactive because the user's current tier no longer allows them to stay active.

createdstring date-time

When the entry was created, when available.

updatedstring date-time

When the entry was last updated, when available.

Example response

{
  "userId": "usr_5pvhvpxyhve6ts31n9x8c2y513",
  "productListingId": "pl_5xdb465tg1enarx2knf04mxbxj",
  "notifications": true,
  "state": "ACTIVE",
  "created": "2026-08-06T12:00:00Z",
  "updated": "2026-08-06T12:00:00Z"
}

Changes

  • 999eda3fdd63Revision changes
    • breaking

      the response's property format changed from uuid to no format for status

    • breaking

      the response's property format changed from uuid to no format for status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • info

      the request property format was generalized from uuid to no format

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

  • 92e104ed3167Revision changes
    • info

      added the non-success response with the status