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

Details indicating whether the operation succeeded.

SearchId

Integer

The ID of the saved favourite.

Response

String or null

A description of the error, if the operation failed.

Saved

Boolean

Indicates whether the favourite was saved.

FavouriteType

Enumeration

Indicates what type of favourite was saved.

None	0	Nothing
Category	1	Category
Search	3	General search
AttributeSearch	4	Attributed search
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
}