Update website settings & data

PATCH /company/websites/@id

Request

Authentication

This endpoint requires authentication.

Header Value
Authorization Set the value to Bearer + + access_token

URL parameters

Replace the @ keywords in the URL with their corresponding value.

A dictionary with fields

Field Type Description
id Int The ID of the website you want to update

Body

Pass the following properties via application/json or form encoding in the body of the request.

todo

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

Example request 1

PATCH /company/websites/13 HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.9.0
Accept-Language: en-US,en;q=0.5
Content-Type: application/json
Content-Length: 1343
{
    "id": 13,
    "title": "...",
    "domain": "...",
    "apps": {
        "apple_appstore_id": "...",
        "android_playstore_id": "...",
        "google_tag_manager_id": "...",
        "android": {
            "app_name": "...",
            "image_url": "..."
        }
    },
    "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": 19,
                "text": 19
            }
        }
    },
    "data": "...",
    "upload_ids": [
        14,
        14,
        19
    ],
    "auth": {
        "has_edit_permissions": false
    }
}

Response

todo

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
company_id Int ID of the company the website belongs to

Example response 1

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 1364

{
    "id": 18,
    "title": "...",
    "domain": "...",
    "apps": {
        "apple_appstore_id": "...",
        "android_playstore_id": "...",
        "google_tag_manager_id": "...",
        "android": {
            "app_name": "...",
            "image_url": "..."
        }
    },
    "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": 14,
                "text": 12
            }
        }
    },
    "data": "...",
    "upload_ids": [
        17,
        14,
        16
    ],
    "auth": {
        "has_edit_permissions": true
    },
    "company_id": 15
}
1.9.0 stable