Website logo

Update a saved favourite's label

Updates the label for a specific favourite.

URL: https://api.trademe.co.nz/v1/favourites/{favouriteId}/{type}/label.{file_format}
HTTP Method: PUT
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)

ID of the favourite to update.
type String (required)

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

PUT Data

<UpdateFavouriteLabelRequest>

Label String (required)

The new label for the favourite.

Returns

<FavouriteLabelResponse>

A response indicating success.

SearchId Integer

The ID of the saved favourite.
Label String or null

The label of the updated favourite.

Example XML Request (switch to JSON) 

<UpdateFavouriteLabelRequest xmlns="http://api.trademe.co.nz/v1">
  <Label>ABC</Label>
</UpdateFavouriteLabelRequest>

Example JSON Request (switch to XML) 

{
  "Label": "ABC"
}

Example XML Response (switch to JSON) 

<FavouriteLabelResponse xmlns="http://api.trademe.co.nz/v1">
  <SearchId>123</SearchId>
  <Label>ABC</Label>
</FavouriteLabelResponse>

Example JSON Response (switch to XML) 

{
  "SearchId": 123,
  "Label": "ABC"
}