Website.detailed

Request

Fields when send to the api inside a request.

Field Type Description
id Int Unique ID of the object
title String Title of the website, mainly used as a prefix in the <title> tag.
domain String Domain of the website
apps Dictionary App IDs
locales [Dictionary] Array of locales
homepage Dictionary Homepage settings
design Dictionary Design related settings
data String A String value
upload_ids [Int] Array of Int
auth Dictionary A dictionary with fields
pages [Page.simple] Array of Page.simple

Response

Fields when returned by the api in a response.

Field Type Description
id Int Unique ID of the object
title String Title of the website, mainly used as a prefix in the <title> tag.
domain String Domain of the website
apps Dictionary App IDs
locales [Dictionary] Array of locales
homepage Dictionary Homepage settings
design Dictionary Design related settings
data String A String value
upload_ids [Int] Array of Int
auth Dictionary A dictionary with fields
pages [Page.simple] Array of Page.simple
company_id Int ID of the company the website belongs to

Examples

Request

When used inside a request.

Example 1

{
    "id": 13,
    "title": "...",
    "domain": "...",
    "apps": {
        "apple_appstore_id": "...",
        "android_playstore_id": "...",
        "google_tag_manager_id": "..."
    },
    "locales": [
        {
            "language": "...",
            "country": "..."
        },
        {
            "language": "...",
            "country": "..."
        },
        {
            "language": "...",
            "country": "..."
        }
    ],
    "homepage": {
        "type": "...",
        "redirect_url": "...",
        "shop_id": "..."
    },
    "design": {
        "color": {
            "colors": {
                "color_1": "#FFFFFF",
                "color_2": "#FFFFFF",
                "color_3": "#FFFFFF",
                "color_4": "#FFFFFF",
                "color_5": "#FFFFFF"
            },
            "use_as_background": "color_1"
        },
        "font": {
            "family": {
                "titles": "...",
                "text": "..."
            },
            "size": {
                "titles": 12,
                "text": 13
            }
        }
    },
    "data": "...",
    "upload_ids": [
        15,
        19,
        19
    ],
    "auth": {
        "has_edit_permissions": false
    },
    "pages": [
        {
            "id": 19,
            "name": "...",
            "url": "...",
            "language": "...",
            "locked": false
        },
        {
            "id": 15,
            "name": "...",
            "url": "...",
            "language": "...",
            "locked": true
        },
        {
            "id": 11,
            "name": "...",
            "url": "...",
            "language": "...",
            "locked": false
        }
    ]
}

Response

When returned in a response.

Example 1

{
    "id": 14,
    "title": "...",
    "domain": "...",
    "apps": {
        "apple_appstore_id": "...",
        "android_playstore_id": "...",
        "google_tag_manager_id": "..."
    },
    "locales": [
        {
            "language": "...",
            "country": "..."
        },
        {
            "language": "...",
            "country": "..."
        },
        {
            "language": "...",
            "country": "..."
        }
    ],
    "homepage": {
        "type": "...",
        "redirect_url": "...",
        "shop_id": "..."
    },
    "design": {
        "color": {
            "colors": {
                "color_1": "#FFFFFF",
                "color_2": "#FFFFFF",
                "color_3": "#FFFFFF",
                "color_4": "#FFFFFF",
                "color_5": "#FFFFFF"
            },
            "use_as_background": "color_1"
        },
        "font": {
            "family": {
                "titles": "...",
                "text": "..."
            },
            "size": {
                "titles": 10,
                "text": 11
            }
        }
    },
    "data": "...",
    "upload_ids": [
        12,
        13,
        18
    ],
    "auth": {
        "has_edit_permissions": false
    },
    "pages": [
        {
            "id": 11,
            "name": "...",
            "url": "...",
            "language": "...",
            "locked": true
        },
        {
            "id": 18,
            "name": "...",
            "url": "...",
            "language": "...",
            "locked": false
        },
        {
            "id": 10,
            "name": "...",
            "url": "...",
            "language": "...",
            "locked": false
        }
    ],
    "company_id": 10
}
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.7.0 stable