Website logo

Update a saved favorite

Modifies the email frequency for a saved favourite.

URL: https://api.trademe.co.nz/v1/favourites/{favouriteId}/{type}/{frequency}.{file_format}
HTTP Method: POST
Requires Authentication? Yes
Permission Required: MyTradeMeWrite: Maintain your watchlist, answer questions and post comments.
Supported Formats: XML, JSON
Rate Limited? Yes

URL parameters

favouriteId Integer (required)

The ID of the favourite.

type String (required)

The type of favourite (must be "Category", "Search", "AttributeSearch" or "Seller").

frequency String (required)

The frequency that emails should be sent (must be "None", "Daily", "Every3Days" or "Weekly").

file_format Enumeration (required) The format of the response.
xml Serialize responses into XML.
json Serialize responses into JSON.

Returns

<SavedFavouriteResponse>

Details indicating whether the operation succeeded.

SearchId Integer SearchId
Response String or null Response
Saved Boolean Saved
FavouriteType Enumeration FavouriteType
None 0 None
Category 1 Category
Search 3 Search
AttributeSearch 4 AttributeSearch
Seller 6 Seller

Example XML Response (switch to JSON)

<SavedFavouriteResponse xmlns="http://api.trademe.co.nz/v1">
  <SearchId>123</SearchId>
  <Response>ABC</Response>
  <Saved>false</Saved>
  <FavouriteType>None</FavouriteType>
</SavedFavouriteResponse>

Example JSON Response (switch to XML)

{
  "SearchId": 123,
  "Response": "ABC",
  "Saved": false,
  "FavouriteType": 0
}