Website logo

Updates a branding image and sets it as default

Update the priority of a specific branding image given the branding id in the url.

It sets the branding image specified in the url to the default for its branding image type. For example, if the member has two branding logos, the branding logo they specify in the url will become the default. Success will always be returned regardless of whether or not the image was previously the default.

NOTE: This operation ignores all elements in the request.

URL: https://api.trademe.co.nz/v1/Member/{memberId}/BrandingImages/{brandingId}.{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

memberId Integer (required)

Member id of the branding image owner
brandingId Integer (required)

Branding image Id to set as default
file_format Enumeration (required) The format of the response.
xml Serialize responses into XML.
json Serialize responses into JSON.

POST Data

<BrandingImageDetails>

BrandingId Integer (optional) BrandingId
FileName String (optional) FileName
FileSize Integer (optional) FileSize
ImageUrl String (optional) ImageUrl
Priority Integer (optional) Priority
BrandingImageType Enumeration (optional) BrandingImageType
Unknown 0 Unknown
Logo 1 Logo
Banner 2 Banner
Square 3 Square
FullScreenBanner 4 FullScreenBanner
Photo 5 Photo

Returns

<UpdateBrandingResponse>

Status of operation

Success Boolean Success

Example XML Request (switch to JSON) 

<BrandingImageDetails xmlns="http://api.trademe.co.nz/v1">
  <BrandingId>123</BrandingId>
  <FileName>ABC</FileName>
  <FileSize>123</FileSize>
  <ImageUrl>ABC</ImageUrl>
  <Priority>123</Priority>
  <BrandingImageType>Unknown</BrandingImageType>
</BrandingImageDetails>

Example JSON Request (switch to XML) 

{
  "BrandingId": 123,
  "FileName": "ABC",
  "FileSize": 123,
  "ImageUrl": "ABC",
  "Priority": 123,
  "BrandingImageType": 0
}

Example XML Response (switch to JSON) 

<UpdateBrandingResponse xmlns="http://api.trademe.co.nz/v1">
  <Success>false</Success>
</UpdateBrandingResponse>

Example JSON Response (switch to XML) 

{
  "Success": false
}