Delete a note
Removes the note from a listing.
| URL: | https://api.trademe.co.nz/v1/MyTradeMe/Notes/{listingId}/{noteId}/{offerId}.{file_format} |
|---|---|
| HTTP Method: | DELETE |
| Requires Authentication? | Yes |
| Permission Required: | MyTradeMeWrite: Maintain your watchlist, answer questions and post comments. |
| Supported Formats: | XML, JSON |
| Rate Limited? | Yes |
URL parameters
| listingId | Integer (required) |
The ID of the listing the note is associated with. |
||||
|---|---|---|---|---|---|---|
| noteId | Integer (required) |
The ID of the note. |
||||
| offerId | Integer (required) |
The ID of the offer the note is associated with. Should be 0 if the note is not associated with a fixed price offer. |
||||
| file_format | Enumeration (required) | The format of the response. | ||||
|
||||||
Returns
<NoteResponse>
Whether the operation was successful and the note details.
| Success | Boolean |
Indicates whether the operation was successful. |
|---|---|---|
| Description | String or null |
The description of the error, if the operation failed. |
| NoteId | Integer |
The ID of the note. |
| OfferId | Integer |
The ID of the fixed price offer, or 0 if the note is not associated with a fixed price offer. |