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 |
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 |
| company_id | Int | ID of the company the website belongs to |
When used inside a request.
{
"id": 10,
"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": 13,
"text": 10
}
}
},
"data": "...",
"upload_ids": [
14,
12,
16
],
"auth": {
"has_edit_permissions": false
}
}When returned in a response.
{
"id": 17,
"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": 15
}
}
},
"data": "...",
"upload_ids": [
17,
18,
15
],
"auth": {
"has_edit_permissions": false
},
"company_id": 18
}