Website logo

Retrieve your email preferences

Retrieves the authenticated user's email preferences.

URL: https://api.trademe.co.nz/v1/mytrademe/emailoptions.{file_format}
HTTP Method: GET
Requires Authentication? Yes
Permission Required: MyTradeMeRead: Read your membership & listing data.
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.

Returns

<EmailOptions>

The authenticated user's email preferences.

WatchlistReminder Enumeration WatchlistReminder
None 0 None
OneHourBefore 1 OneHourBefore
TwelveHoursBefore 2 TwelveHoursBefore
TwentyFourHoursBefore 4 TwentyFourHoursBefore
Newsletter Enumeration Newsletter
None 0 None
Monthly 1 Monthly
Motors 2 Motors
Property 4 Property
Jobs 8 Jobs
DailyDeals 16 DailyDeals
EmailFormat Enumeration EmailFormat
Html 1 Html
Plain 2 Plain
EmailMemberWhen Enumeration EmailMemberWhen
None 0 None
FpoDeclined 1 FpoDeclined
FpoExpired 2 FpoExpired
NewFeedback 4 NewFeedback
DailyListingSummary 8 DailyListingSummary
ListingUnsold 16 ListingUnsold
ListingSold 32 ListingSold
Outbid 64 Outbid
BuyNowAdded 128 BuyNowAdded
ClassifiedExpired 256 ClassifiedExpired
ServiceReviewed 512 ServiceReviewed
FixedPriceOffer Enumeration FixedPriceOffer
None 0 None
Bid 1 Bid
Watchlist 2 Watchlist
BidAndWatchlist 3 BidAndWatchlist
Relist Enumeration Relist
None 0 None
Bid 1 Bid
Watchlist 2 Watchlist
BidAndWatchlist 3 BidAndWatchlist
Agent Enumeration Agent
None 0 None
Current 1 Current
SevenDays 2 SevenDays
FortyfiveDays 4 FortyfiveDays
AgentReportFormat Enumeration AgentReportFormat
None 0 None
Csv 1 Csv
Pdf 2 Pdf
Promotional Enumeration or null Promotional
None 0 None
TradeMeProperty 2 TradeMeProperty
TradeMeJobs 4 TradeMeJobs
TradeMeMotors 8 TradeMeMotors
FindSomeone 16 FindSomeone
Travelbug 32 Travelbug
HolidayHouses 64 HolidayHouses
LifeDirect 128 LifeDirect
Harmoney 256 Harmoney
TradeMeInsurance 512 TradeMeInsurance
Sharesies 1024 Sharesies
Marketing Enumeration or null Marketing
None 0 None
Tips 1 Tips
Promos 2 Promos
SellerSpecials 4 SellerSpecials
Specials 8 Specials
TradeMeUpdates Enumeration or null TradeMeUpdates
None 0 None
CompsAndPromos 1 CompsAndPromos
DealsAndOffers 2 DealsAndOffers
PersonalisedRecommendations 4 PersonalisedRecommendations
Surveys 8 Surveys
TipsAndUpdates 16 TipsAndUpdates
Services 32 Services
TradeMePropertyUpdates Enumeration or null TradeMePropertyUpdates
None 0 None
CompsAndPromos 1 CompsAndPromos
DealsAndOffers 2 DealsAndOffers
PersonalisedRecommendations 4 PersonalisedRecommendations
Surveys 8 Surveys
TipsAndUpdates 16 TipsAndUpdates
TradeMeJobsUpdates Enumeration or null TradeMeJobsUpdates
None 0 None
CompsAndPromos 1 CompsAndPromos
DealsAndOffers 2 DealsAndOffers
PersonalisedRecommendations 4 PersonalisedRecommendations
Surveys 8 Surveys
TipsAndUpdates 16 TipsAndUpdates
TradeMeMotorsUpdates Enumeration or null TradeMeMotorsUpdates
None 0 None
CompsAndPromos 1 CompsAndPromos
DealsAndOffers 2 DealsAndOffers
PersonalisedRecommendations 4 PersonalisedRecommendations
Surveys 8 Surveys
TipsAndUpdates 16 TipsAndUpdates

Example XML Response (switch to JSON) 

<EmailOptions xmlns="http://api.trademe.co.nz/v1">
  <WatchlistReminder>None</WatchlistReminder>
  <Newsletter>None</Newsletter>
  <EmailFormat>Html</EmailFormat>
  <EmailMemberWhen>None</EmailMemberWhen>
  <FixedPriceOffer>None</FixedPriceOffer>
  <Relist>None</Relist>
  <Agent>None</Agent>
  <AgentReportFormat>None</AgentReportFormat>
  <Promotional>None</Promotional>
  <Marketing>None</Marketing>
  <TradeMeUpdates>None</TradeMeUpdates>
  <TradeMePropertyUpdates>None</TradeMePropertyUpdates>
  <TradeMeJobsUpdates>None</TradeMeJobsUpdates>
  <TradeMeMotorsUpdates>None</TradeMeMotorsUpdates>
</EmailOptions>

Example JSON Response (switch to XML) 

{
  "WatchlistReminder": 0,
  "Newsletter": 0,
  "EmailFormat": 1,
  "EmailMemberWhen": 0,
  "FixedPriceOffer": 0,
  "Relist": 0,
  "Agent": 0,
  "AgentReportFormat": 0,
  "Promotional": 0,
  "Marketing": 0,
  "TradeMeUpdates": 0,
  "TradeMePropertyUpdates": 0,
  "TradeMeJobsUpdates": 0,
  "TradeMeMotorsUpdates": 0
}