1. API
  2. v1
  3. CHANNELS
  4. HELP CENTER

Favicon

Resource Fields

Name Type Read-only Description
name string
size integer
width integer
height integer
type string
url string
thumbnails Thumbnails There will be thumbnails in various dimensions.

Variations: 32x32, 46x46, 72x72, 96x96, 144x144

Thumbnails

RESOURCE FIELDS

Name Type Read-only Description
name string
size integer
width integer
height integer
type string
Mime-type of the file
url string
The url to view the thumbnail



Metadata




 
 



Version 1.0
Last Updated July 04, 2016

Actions

Retrieve favicon

GET /api/v1/favicon.json

Information

Allowed for Public

Arguments

Name Type Mandatory Description
brand_id integer Favicon for the brand

Response

    {
        "status": 200,
        "data": {
    "name": "favicon.png",
    "size": 730,
    "width": 16,
    "height": 16,
    "type": "image/jpeg",
    "url": "https://brewfictus.kayako.com/api/v1/favicon/render",
    "thumbnails": [
        {
            "name": "favicon-32.png",
            "size": 789,
            "width": 32,
            "height": 32,
            "type": "image/jpeg",
            "url": "https://brewfictus.kayako.com/api/v1/favicon/render&size=32"
        }
    ]
},
        "resource": "favicon"
    }

Render favicon

GET /api/v1/favicon/render.json

Information

Allowed for Public

This output/render image to browser.

Arguments

Name Type Mandatory Description
brand_id integer Favicon for the brand

Replace favicon

PUT /api/v1/favicon.json

Information

Allowed for Admins & Owners

Parameters

Name Type Mandatory Description
image multipart/form-data
Large image will be scaled down

Allowed Image type: PNG
brand_id integer Favicon for the brand

Response

    {
        "status": 200,
        "data": {
    "name": "favicon.png",
    "size": 730,
    "width": 16,
    "height": 16,
    "type": "image/jpeg",
    "url": "https://brewfictus.kayako.com/api/v1/favicon/render",
    "thumbnails": [
        {
            "name": "favicon-32.png",
            "size": 789,
            "width": 32,
            "height": 32,
            "type": "image/jpeg",
            "url": "https://brewfictus.kayako.com/api/v1/favicon/render&size=32"
        }
    ]
},
        "resource": "favicon"
    }

Delete favicon

DELETE /api/v1/favicon.json

Information

Allowed for Admins & Owners

Arguments

Name Type Mandatory Description
brand_id integer Favicon for the brand

Response

{
    "status": 200
}