Create or update a note

Creates or updates the note on a listing.

URL:	https://api.trademe.co.nz/v1/MyTradeMe/Notes.{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

file_format

Enumeration (required)

The format of the response.

xml	Serialize responses into XML.
json	Serialize responses into JSON.

POST Data

Text	String (required)	Text
ListingId	Integer (required)	ListingId
NoteId	Integer (optional)	NoteId
OfferId	Integer (optional)	OfferId
PurchaseId	Integer (optional)	PurchaseId

Returns

Whether the operation was successful and the note details.

Success	Boolean	Success
Description	String or null	Description
NoteId	Integer	NoteId
Text	String or null	Text
OfferId	Integer	OfferId

Example XML Request (switch to JSON)

<SaveNoteRequest xmlns="http://api.trademe.co.nz/v1">
  <Text>ABC</Text>
  <ListingId>123</ListingId>
  <NoteId>123</NoteId>
  <OfferId>123</OfferId>
  <PurchaseId>123</PurchaseId>
</SaveNoteRequest>

Example JSON Request (switch to XML)

{
  "Text": "ABC",
  "ListingId": 123,
  "NoteId": 123,
  "OfferId": 123,
  "PurchaseId": 123
}

Example XML Response (switch to JSON)

<NoteResponse xmlns="http://api.trademe.co.nz/v1">
  <Success>false</Success>
  <Description>ABC</Description>
  <NoteId>123</NoteId>
  <Text>ABC</Text>
  <OfferId>123</OfferId>
</NoteResponse>

Example JSON Response (switch to XML)

{
  "Success": false,
  "Description": "ABC",
  "NoteId": 123,
  "Text": "ABC",
  "OfferId": 123
}