1. API
  2. v1
  3. CHANNELS
  4. MAIL

Mailboxes

Resource Fields

Name Type Read-only Description
uuid string
address string
brand Brand
is_system boolean
is_custom boolean
is_verified boolean
is_default boolean
is_enabled boolean
is_deleted boolean
verified_at timestamp ISO-8601 Format
created_at timestamp ISO-8601 Format
updated_at timestamp ISO-8601 Format

Mailbox Configuration

Name Type Read-only Description
is_valid boolean
Whether or not the mailbox is configured properly
dns_records DNS Records
The expected DNS records to be set for mailbox configuration

DNS Record

Name Type Read-only Description
type string
A valid DNS record type, such as CNAME, TXT
domain string
The domain that this DNS record is expected to be set on
expected_value string
The expected value for this record
actual_values array
The values that are currently present on the domain for this record type. This will be an empty array if no records exist for that record type
is_valid boolean
Whether or not the DNS record is setup properly



Metadata




 
 



Version 1.0
Last Updated July 04, 2016

Actions

Retrieve all mailboxes

GET /api/v1/mailboxes.json

Information

Allowed for Collaborators, Agents, Admins & Owners

Response

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

    "uuid": "d2e7d14a-2db0-4af4-81f2-50801bdb6dd9",
    "address": "support@brewfictus.com",
    "brand": {
    "id": 1,

    "resource_type": "brand"

}
,
    "is_system": true,
    "is_custom": true,
    "is_verified": true,
    "is_default": true,
    "is_enabled": true,
    "is_deleted": false,
    "verified_at": "2015-07-02T07:28:25+05:00",
    "created_at": "2015-08-18T17:45:49+05:00",
    "updated_at": "2015-08-18T17:45:49+05:00",

    "resource_type": "mailbox"

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

}

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

Retrieve a mailbox

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

Information

Allowed for Collaborators, Agents, Admins & Owners

Response

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

    "uuid": "d2e7d14a-2db0-4af4-81f2-50801bdb6dd9",
    "address": "support@brewfictus.com",
    "brand": {
    "id": 1,

    "resource_type": "brand"

}
,
    "is_system": true,
    "is_custom": true,
    "is_verified": true,
    "is_default": true,
    "is_enabled": true,
    "is_deleted": false,
    "verified_at": "2015-07-02T07:28:25+05:00",
    "created_at": "2015-08-18T17:45:49+05:00",
    "updated_at": "2015-08-18T17:45:49+05:00",

    "resource_type": "mailbox"

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

}
,
        "resource": "mailbox"
    }

Retrieve mailbox configuration

GET /api/v1/mailboxes/:id/configuration.json

Information

Allowed for Collaborators, Agents, Admins & Owners

Response

{
    "status": 200,
    "data": {
        "is_valid": true,
        "dns_records": [
            {
                "type": "CNAME",
                "domain": "email.brewfictus.com",
                "expected_value": "email.kayako.com",
                "actual_values": ["email.kayako.com"],
                "is_valid": true,
                "resource_type": "dns_record"
            },
            {
                "type": "CNAME",
                "domain": "s1._domainkey.brewfictus.com",
                "expected_value": "s1._domainkey.kayako.com",
                "actual_values": ["s1._domainkey.kayako.com"],
                "is_valid": true,
                "resource_type": "dns_record"
            },
            {
                "type": "CNAME",
                "domain": "s2._domainkey.brewfictus.com",
                "expected_value": "s2._domainkey.kayako.com",
                "actual_values": ["s2._domainkey.kayako.com"],
                "is_valid": true,
                "resource_type": "dns_record"
            }
        ],
        "resource_type": "mailbox_configuration"
    },
    "resource": "mailbox_configuration"
}

Add a mailbox

POST /api/v1/mailboxes.json

Information

Allowed for Admins & Owners

Parameters

Name Type Mandatory Description
address string
brand_id integer If not specified, default brand is set to the mailbox
is_default boolean Default: false

Response

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

    "uuid": "d2e7d14a-2db0-4af4-81f2-50801bdb6dd9",
    "address": "support@brewfictus.com",
    "brand": {
    "id": 1,

    "resource_type": "brand"

}
,
    "is_system": true,
    "is_custom": true,
    "is_verified": true,
    "is_default": true,
    "is_enabled": true,
    "is_deleted": false,
    "verified_at": "2015-07-02T07:28:25+05:00",
    "created_at": "2015-08-18T17:45:49+05:00",
    "updated_at": "2015-08-18T17:45:49+05:00",

    "resource_type": "mailbox"

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

}
,
        "resource": "mailbox"
    }

Update a mailbox

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

Information

Allowed for Admins & Owners

Parameters

Name Type Mandatory Description
brand_id integer
is_enabled boolean
is_default boolean

Response

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

    "uuid": "d2e7d14a-2db0-4af4-81f2-50801bdb6dd9",
    "address": "support@brewfictus.com",
    "brand": {
    "id": 1,

    "resource_type": "brand"

}
,
    "is_system": true,
    "is_custom": true,
    "is_verified": true,
    "is_default": true,
    "is_enabled": true,
    "is_deleted": false,
    "verified_at": "2015-07-02T07:28:25+05:00",
    "created_at": "2015-08-18T17:45:49+05:00",
    "updated_at": "2015-08-18T17:45:49+05:00",

    "resource_type": "mailbox"

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

}
,
        "resource": "mailbox"
    }

Update mailboxes

PUT /api/v1/mailboxes.json

Information

Allowed for Admins & Owners

Arguments

Name Type Mandatory Description
ids string
The comma separated ids

Parameters

Name Type Mandatory Description
is_enabled boolean

Response

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

Mark as default

PUT /api/v1/mailboxes/default.json

Information

Allowed for Admins & Owners

Parameters

Name Type Mandatory Description
mailbox_id integer

Response

{
    "status": 200
}

Delete a mailbox

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

Information

Allowed for Admins & Owners

Response

{
    "status": 200
}

Delete mailboxes

DELETE /api/v1/mailboxes.json

Information

Allowed for Admins & Owners

Arguments

Name Type Mandatory Description
ids string
The comma separated ids

Response

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