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)

Branding image Id. Use this Id to add branding to your listings. This property is read-only.

FileName String (optional)

Branding image file name. This property is read-only. The file name may be different from the value provided during uploading the image.

FileSize Long Integer (optional)

Branding image file size in bytes. This property is read-only.

ImageUrl String (optional)

The location of the image. This property is read-only.

Priority Integer (optional)

The prorioty of this branding image relative to other uploaded images. This property is only applicable to agent branding and is ignored for listing specific branding. Default value is 0.

BrandingImageType Enumeration (optional)

Branding image type

Unknown 0

Default value; It should not be used

Logo 1

Branding logo (Width= 480px, Height= 200px)

Banner 2

Branding banner (Width= 758px, Height= 75px)

Square 3

Branding square (Width= 480px, Height= 480px)

Returns

<UpdateBrandingResponse>

Status of operation

Success Boolean

Indicates whether the operation was successful.

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
}