Show Website - Placewise API

Request

Header Params

Content-Type

enum<string>

required

Details

Allowed value:

application/json

Default:

application/json

X-User-Agent

string

required

Arbitrary identifier of your client. Details

Default:

X-Product-Name

string

required

API Product for API context. Details

Default:

X-Loyalty-Club-Slug

string

required

LoyaltyClub for API context. Details

Default:

X-Customer

string

required

Customer for API context. Details

Default:

Authorization

string

required

Member or User Authorization.

Default:

Bearer {{_OAUTH_TOKEN}}

X-Client-Authorization

string

optional

Default:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

website

object (Website)

required

integer <uint64>

read-onlyrequired

Example:

primary_language

string

required

Example:

secondary_languages

array[string]

required

Example:

["no","pl"]

service_pages

object

read-onlyrequired

Service pages setup

layout

object

required

(WIP) Describes general layout of the website

config

object | null

required

Contains arbitrary configuration values for the website

service_type

enum<string>

required

Website's deployment type

Allowed values:

nextjslucee

Example:

nextjs

service_name

string | null

required

service_namespace

enum<string>

required

Allowed values:

app-cms-bentoapp-cms-websitesapp-lucee-websites

Example:

app-cms-websites

lucee_site_location

string | null

required

favicon

object (File) | null

read-onlyrequired

Must be uploaded as a file of type: cms_website_favicon

created_at

string <date-time>

read-onlyrequired

Time of record creation

Example:

2022-11-05T16:25:58.099512Z

updated_at

string <date-time>

read-onlyrequired

Time of the last record update

Example:

2022-11-15T16:25:58.099512Z

tracking_identifiers

array [object {2}]

required

Example

{
    "website": {
        "id": 1,
        "primary_language": "en",
        "secondary_languages": [
            "no",
            "pl"
        ],
        "service_pages": {
            "home_page": {
                "id": 1,
                "url": "path/to/:id"
            },
            "articles_list": {
                "id": 1,
                "url": "path/to/:id"
            },
            "article_page": {
                "id": 1,
                "url": "path/to/:id"
            },
            "events_list": {
                "id": 1,
                "url": "path/to/:id"
            },
            "event_page": {
                "id": 1,
                "url": "path/to/:id"
            },
            "promotions_list": {
                "id": 1,
                "url": "path/to/:id"
            },
            "promotion_page": {
                "id": 1,
                "url": "path/to/:id"
            },
            "stores_list": {
                "id": 1,
                "url": "path/to/:id"
            },
            "store_page": {
                "id": 1,
                "url": "path/to/:id"
            },
            "jobs_list": {
                "id": 1,
                "url": "path/to/:id"
            },
            "job_page": {
                "id": 1,
                "url": "path/to/:id"
            },
            "press_releases_list": {
                "id": 1,
                "url": "path/to/:id"
            },
            "press_release_page": {
                "id": 1,
                "url": "path/to/:id"
            }
        },
        "layout": {
            "components": [
                {}
            ]
        },
        "config": {},
        "service_type": "nextjs",
        "service_name": "string",
        "service_namespace": "app-cms-bento",
        "lucee_site_location": "string",
        "favicon": {
            "url": "https://example.com/image.png",
            "identifier": "1",
            "mime_type": "image/jpeg",
            "created_at": "2022-11-09T15:46:00.252860Z",
            "updated_at": "2022-11-09T15:46:00.252860Z",
            "image_details": {
                "width": 1,
                "height": 1
            }
        },
        "created_at": "2022-11-05T16:25:58.099512Z",
        "updated_at": "2022-11-15T16:25:58.099512Z",
        "tracking_identifiers": [
            {
                "type": "google_analytics",
                "value": "string"
            }
        ]
    }
}