1. API
  2. v1
  3. OTHER
  4. GENERAL

Brands

Resource Fields

Name Type Read-only Description
name string
subdomain string
domain string
alias string
locale Locale
is_ssl_enabled boolean True if SSL certificate is uploaded
is_default boolean Default: false
is_enabled boolean Default: true
created_at timestamp ISO-8601 Format
updated_at timestamp ISO-8601 Format



Metadata




 
 



Version 1.0
Last Updated July 04, 2016

Actions

Retrieve all brands

GET /api/v1/brands.json

Information

Allowed for Customers, Collaborators, Agents, Admins & Owners
Scope configuration

Response

    {
        "status": 200,
        "data": [
            {
    "id": 1,

    "name": "Default",
    "sub_domain": "brewfictus",
    "domain": "kayako.com",
    "alias": null,
    "locale": {
    "id": 1,

    "resource_type": "locale"

},
    "is_ssl_enabled": true,
    "is_default": true,
    "is_enabled": true,
    "created_at": "2015-07-27T11:35:09+05:00",
    "updated_at": "2015-07-27T11:35:09+05:00",

    "resource_type": "brand"

    ,"resource_url": "https://brewfictus.kayako.com/api/v1/brands/1"

}

        ],
        "resource": "brand",
        "offset": 0,
        "limit": 10,
        "total_count": 1
    }

Retrieve a brand

GET /api/v1/brands/:id.json

Information

Allowed for Customers, Collaborators, Agents, Admins & Owners
Scope configuration

Response

    {
        "status": 200,
        "data": {
    "id": 1,

    "name": "Default",
    "sub_domain": "brewfictus",
    "domain": "kayako.com",
    "alias": null,
    "locale": {
    "id": 1,

    "resource_type": "locale"

},
    "is_ssl_enabled": true,
    "is_default": true,
    "is_enabled": true,
    "created_at": "2015-07-27T11:35:09+05:00",
    "updated_at": "2015-07-27T11:35:09+05:00",

    "resource_type": "brand"

    ,"resource_url": "https://brewfictus.kayako.com/api/v1/brands/1"

}
,
        "resource": "brand"
    }

Check domain availability

POST /api/v1/brands/available.json

Information

Allowed for Admins & Owners
Scope configuration

Parameters

Name Type Mandatory Description
sub_domain string

Response

{
    "status": 200
}

Validate alias

POST /api/v1/brands/validate.json

Information

Allowed for Admins & Owners
Scope configuration

Parameters

Name Type Mandatory Description
sub_domain string
alias string
Alias should have a valid CNAME set to domain

Response

{
    "status": 200
}

Add a brand

POST /api/v1/brands.json

Information

Allowed for Admins & Owners
Scope configuration

Parameters

Name Type Mandatory Description
name string
sub_domain string
alias string
locale_id integer
Locales
ssl_certificate string
base64 encoded, mandatory to pass if alias provided
private_key string
base64 encoded, mandatory to pass if alias provided

Response

    {
        "status": 201,
        "data": {
    "id": 1,

    "name": "Default",
    "sub_domain": "brewfictus",
    "domain": "kayako.com",
    "alias": null,
    "locale": {
    "id": 1,

    "resource_type": "locale"

},
    "is_ssl_enabled": true,
    "is_default": true,
    "is_enabled": true,
    "created_at": "2015-07-27T11:35:09+05:00",
    "updated_at": "2015-07-27T11:35:09+05:00",

    "resource_type": "brand"

    ,"resource_url": "https://brewfictus.kayako.com/api/v1/brands/1"

}
,
        "resource": "brand"
    }

Update a brand

PUT /api/v1/brands/:id.json

Information

Allowed for Admins & Owners
Scope configuration

Parameters

Name Type Mandatory Description
name string
alias string
locale_id integer Locales
ssl_certificate string
base64 encoded, mandatory to pass if alias changed
private_key string
base64 encoded, mandatory to pass if alias changed
is_enabled boolean
is_default boolean

Response

    {
        "status": 200,
        "data": {
    "id": 1,

    "name": "Default",
    "sub_domain": "brewfictus",
    "domain": "kayako.com",
    "alias": null,
    "locale": {
    "id": 1,

    "resource_type": "locale"

},
    "is_ssl_enabled": true,
    "is_default": true,
    "is_enabled": true,
    "created_at": "2015-07-27T11:35:09+05:00",
    "updated_at": "2015-07-27T11:35:09+05:00",

    "resource_type": "brand"

    ,"resource_url": "https://brewfictus.kayako.com/api/v1/brands/1"

}
,
        "resource": "brand"
    }

Get SSL Certificate

GET /api/v1/brands/:id/certificate.json

Information

Allowed for Admins & Owners
Scope configuration

Response

    {
      "status": 200,
      "data": {
        "certificate": "---- DUMMY CERTIFICATE CONTENT HERE ----"
      },
      "resource": "ssl_certificate"
    }

Mass action on brands

PUT /api/v1/brands.json

Information

Allowed for Admins & Owners
Scope configuration

Arguments

Name Type Mandatory Description
ids string

Parameters

Name Type Mandatory Description
is_enabled boolean

Response

{
    "status": 200,
    "total_count": 2
}

Delete a brand

DELETE /api/v1/brands/:id.json

Information

Allowed for Admins & Owners
Scope configuration

Note: Brand set as default cannot be deleted.

Response

{
    "status": 200
}

Delete brands

DELETE /api/v1/brands.json

Information

Allowed for Admins & Owners
Scope configuration

Note: Brand set as default cannot be deleted.

Arguments

Name Type Mandatory Description
ids string
The comma separated ids

Response

{
    "status": 200,
    "total_count": 2
}